Skip to content

Latest commit

 

History

History
155 lines (96 loc) · 5.15 KB

README.rst

File metadata and controls

155 lines (96 loc) · 5.15 KB
Release Release
Deployment PyPI Conda (channel only)
Build Status pipeline status
Metrics coverage report
Activity PyPI - Downloads Conda
Citation zenodo
License license
Formatter Code style: black

nannos: Fourier Modal Method for multilayer metamaterials

Installation

From conda

If using conda, first, add conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, nannos can be installed with:

conda install nannos

Alternatively, we provide an environment.yml file with all the dependencies for the master branch. First create the environment:

conda env create -f environment.yml

and then activate it with

conda activate nannos

See the github repository where development happens for conda-forge.

From pypi

The package is available on pypi. To install, simply use:

pip install nannos

From sources

Sources are available on gitlab. First clone the repository and install with pip:

git clone https://gitlab.com/nannos/nannos.git
cd nannos
pip install -e .

Documentation

The reference documentation and examples can be found on the project website.

License

This software is published under the GPLv3 license.