nannos


Namenannos JSON
Version 2.6.2 PyPI version JSON
download
home_pagehttps://gitlab.com/nannos/nannos
SummaryFourier Modal Method for multilayer metamaterials
upload_time2024-03-13 16:23:32
maintainer
docs_urlNone
authorBenjamin Vial
requires_python>=3.6
licenseGPL-3.0-or-later
keywords fourier modal method diffraction optics photonics metamaterials
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
.. |release_badge| image:: https://img.shields.io/endpoint?url=https://gitlab.com/nannos/nannos/-/jobs/artifacts/master/raw/logobadge.json?job=badge
  :target: https://gitlab.com/nannos/nannos/-/releases
  :alt: Release

.. |GL_CI| image:: https://img.shields.io/gitlab/pipeline/nannos/nannos/master?logo=gitlab&labelColor=grey&style=for-the-badge
  :target: https://gitlab.com/nannos/nannos/commits/master
  :alt: pipeline status

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/nannos?logo=conda-forge&color=CD5C5C&logoColor=white&style=for-the-badge   
  :target: https://anaconda.org/conda-forge/nannos
  :alt: Conda (channel only)

.. |conda_dl| image:: https://img.shields.io/conda/dn/conda-forge/nannos?logo=conda-forge&logoColor=white&style=for-the-badge
  :alt: Conda

.. |conda_platform| image:: https://img.shields.io/conda/pn/conda-forge/nannos?logo=conda-forge&logoColor=white&style=for-the-badge
  :alt: Conda


.. |pip| image:: https://img.shields.io/pypi/v/nannos?color=blue&logo=pypi&logoColor=e9d672&style=for-the-badge
  :target: https://pypi.org/project/nannos/
  :alt: PyPI
  
.. |pip_dl| image:: https://img.shields.io/pypi/dm/nannos?logo=pypi&logoColor=e9d672&style=for-the-badge   
  :alt: PyPI - Downloads
   
.. |pip_status| image:: https://img.shields.io/pypi/status/nannos?logo=pypi&logoColor=e9d672&style=for-the-badge   
  :alt: PyPI - Status

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=e9d672&style=for-the-badge
  :alt: Code style: black
 
.. |coverage| image:: https://img.shields.io/gitlab/coverage/nannos/nannos/master?logo=python&logoColor=e9d672&style=for-the-badge
  :target: https://gitlab.com/nannos/nannos/commits/master
  :alt: coverage report 
  
.. |zenodo| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.6490098-dd7d54?logo=google-scholar&logoColor=dd7d54&style=for-the-badge
  :target: https://doi.org/10.5281/zenodo.6490098
 
.. |licence| image:: https://img.shields.io/badge/license-GPLv3-blue?color=dd7d54&logo=open-access&logoColor=dd7d54&style=for-the-badge
  :target: https://gitlab.com/nannos/nannos/-/blob/master/LICENCE.txt
  :alt: license

+----------------------+----------------------+----------------------+
| Release              |            |release_badge|                  |
+----------------------+----------------------+----------------------+
| Deployment           | |pip|                |        |conda|       |
+----------------------+----------------------+----------------------+
| Build Status         |            |GL_CI|                          |
+----------------------+----------------------+----------------------+
| Metrics              |                |coverage|                   |
+----------------------+----------------------+----------------------+
| Activity             |     |pip_dl|         |      |conda_dl|      |
+----------------------+----------------------+----------------------+
| Citation             |           |zenodo|                          |
+----------------------+----------------------+----------------------+
| License              |           |licence|                         |
+----------------------+----------------------+----------------------+
| Formatter            |           |black|                           |
+----------------------+----------------------+----------------------+



.. inclusion-marker-badges

=============================================================
nannos: Fourier Modal Method for multilayer metamaterials
=============================================================


.. inclusion-marker-install-start

Installation
============

From conda
----------

If using `conda <https://www.anaconda.com/>`_, first, add conda-forge to your channels with:

.. code-block:: bash
    
    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:

.. code-block:: bash
  
  conda install nannos


Alternatively, we provide an `environment.yml <https://gitlab.com/nannos/nannos/-/blob/master/environment.yml>`_ 
file with all the dependencies for the master branch. First create the environment:

.. code-block:: bash

  conda env create -f environment.yml

and then activate it with 

.. code-block:: bash

  conda activate nannos
  

See the `github repository <https://github.com/conda-forge/nannos-feedstock/>`_ 
where development happens for conda-forge.
  

From pypi
---------

The package is available on `pypi <https://pypi.org/project/nannos>`_.
To install, simply use:

.. code-block:: bash

  pip install nannos


From sources
-------------

Sources are available on `gitlab <https://gitlab.com/nannos/nannos>`_. First
clone the repository and install with ``pip``:

.. code-block:: bash

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


.. inclusion-marker-install-end


Documentation
=============

The reference documentation and examples can be found on the
`project website <https://nannos.gitlab.io>`_.


License
=======


.. inclusion-marker-license-start

This software is published under the `GPLv3 license <https://www.gnu.org/licenses/gpl-3.0.en.html>`_.


.. inclusion-marker-license-end

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/nannos/nannos",
    "name": "nannos",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "fourier modal method,diffraction,optics,photonics,metamaterials",
    "author": "Benjamin Vial",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/86/7c/9dbcb3020fadea4f38974e8aaf5b8c2b833bdf26c532d241e5e7694fd719/nannos-2.6.2.tar.gz",
    "platform": null,
    "description": "\n.. |release_badge| image:: https://img.shields.io/endpoint?url=https://gitlab.com/nannos/nannos/-/jobs/artifacts/master/raw/logobadge.json?job=badge\n  :target: https://gitlab.com/nannos/nannos/-/releases\n  :alt: Release\n\n.. |GL_CI| image:: https://img.shields.io/gitlab/pipeline/nannos/nannos/master?logo=gitlab&labelColor=grey&style=for-the-badge\n  :target: https://gitlab.com/nannos/nannos/commits/master\n  :alt: pipeline status\n\n.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/nannos?logo=conda-forge&color=CD5C5C&logoColor=white&style=for-the-badge   \n  :target: https://anaconda.org/conda-forge/nannos\n  :alt: Conda (channel only)\n\n.. |conda_dl| image:: https://img.shields.io/conda/dn/conda-forge/nannos?logo=conda-forge&logoColor=white&style=for-the-badge\n  :alt: Conda\n\n.. |conda_platform| image:: https://img.shields.io/conda/pn/conda-forge/nannos?logo=conda-forge&logoColor=white&style=for-the-badge\n  :alt: Conda\n\n\n.. |pip| image:: https://img.shields.io/pypi/v/nannos?color=blue&logo=pypi&logoColor=e9d672&style=for-the-badge\n  :target: https://pypi.org/project/nannos/\n  :alt: PyPI\n  \n.. |pip_dl| image:: https://img.shields.io/pypi/dm/nannos?logo=pypi&logoColor=e9d672&style=for-the-badge   \n  :alt: PyPI - Downloads\n   \n.. |pip_status| image:: https://img.shields.io/pypi/status/nannos?logo=pypi&logoColor=e9d672&style=for-the-badge   \n  :alt: PyPI - Status\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=e9d672&style=for-the-badge\n  :alt: Code style: black\n \n.. |coverage| image:: https://img.shields.io/gitlab/coverage/nannos/nannos/master?logo=python&logoColor=e9d672&style=for-the-badge\n  :target: https://gitlab.com/nannos/nannos/commits/master\n  :alt: coverage report \n  \n.. |zenodo| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.6490098-dd7d54?logo=google-scholar&logoColor=dd7d54&style=for-the-badge\n  :target: https://doi.org/10.5281/zenodo.6490098\n \n.. |licence| image:: https://img.shields.io/badge/license-GPLv3-blue?color=dd7d54&logo=open-access&logoColor=dd7d54&style=for-the-badge\n  :target: https://gitlab.com/nannos/nannos/-/blob/master/LICENCE.txt\n  :alt: license\n\n+----------------------+----------------------+----------------------+\n| Release              |            |release_badge|                  |\n+----------------------+----------------------+----------------------+\n| Deployment           | |pip|                |        |conda|       |\n+----------------------+----------------------+----------------------+\n| Build Status         |            |GL_CI|                          |\n+----------------------+----------------------+----------------------+\n| Metrics              |                |coverage|                   |\n+----------------------+----------------------+----------------------+\n| Activity             |     |pip_dl|         |      |conda_dl|      |\n+----------------------+----------------------+----------------------+\n| Citation             |           |zenodo|                          |\n+----------------------+----------------------+----------------------+\n| License              |           |licence|                         |\n+----------------------+----------------------+----------------------+\n| Formatter            |           |black|                           |\n+----------------------+----------------------+----------------------+\n\n\n\n.. inclusion-marker-badges\n\n=============================================================\nnannos: Fourier Modal Method for multilayer metamaterials\n=============================================================\n\n\n.. inclusion-marker-install-start\n\nInstallation\n============\n\nFrom conda\n----------\n\nIf using `conda <https://www.anaconda.com/>`_, first, add conda-forge to your channels with:\n\n.. code-block:: bash\n    \n    conda config --add channels conda-forge\n    conda config --set channel_priority strict\n\nOnce the conda-forge channel has been enabled, nannos can be installed with:\n\n.. code-block:: bash\n  \n  conda install nannos\n\n\nAlternatively, we provide an `environment.yml <https://gitlab.com/nannos/nannos/-/blob/master/environment.yml>`_ \nfile with all the dependencies for the master branch. First create the environment:\n\n.. code-block:: bash\n\n  conda env create -f environment.yml\n\nand then activate it with \n\n.. code-block:: bash\n\n  conda activate nannos\n  \n\nSee the `github repository <https://github.com/conda-forge/nannos-feedstock/>`_ \nwhere development happens for conda-forge.\n  \n\nFrom pypi\n---------\n\nThe package is available on `pypi <https://pypi.org/project/nannos>`_.\nTo install, simply use:\n\n.. code-block:: bash\n\n  pip install nannos\n\n\nFrom sources\n-------------\n\nSources are available on `gitlab <https://gitlab.com/nannos/nannos>`_. First\nclone the repository and install with ``pip``:\n\n.. code-block:: bash\n\n  git clone https://gitlab.com/nannos/nannos.git\n  cd nannos\n  pip install -e .\n\n\n.. inclusion-marker-install-end\n\n\nDocumentation\n=============\n\nThe reference documentation and examples can be found on the\n`project website <https://nannos.gitlab.io>`_.\n\n\nLicense\n=======\n\n\n.. inclusion-marker-license-start\n\nThis software is published under the `GPLv3 license <https://www.gnu.org/licenses/gpl-3.0.en.html>`_.\n\n\n.. inclusion-marker-license-end\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "Fourier Modal Method for multilayer metamaterials",
    "version": "2.6.2",
    "project_urls": {
        "Code": "https://gitlab.com/nannos/nannos",
        "Documentation": "https://nannos.gitlab.io",
        "Homepage": "https://gitlab.com/nannos/nannos",
        "Issues": "https://gitlab.com/nannos/nannos/issues"
    },
    "split_keywords": [
        "fourier modal method",
        "diffraction",
        "optics",
        "photonics",
        "metamaterials"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8fe61f649e3fe4b6147f005f1f036ff3ef62b7d7ea1a2b4ed6c0cc20a0078569",
                "md5": "7b868e121deb9f33ae1deaba2902f763",
                "sha256": "edd37b0b8334d3c71dd7282d933186af5073fec10c9f9a812498c45613c312e3"
            },
            "downloads": -1,
            "filename": "nannos-2.6.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7b868e121deb9f33ae1deaba2902f763",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 49726,
            "upload_time": "2024-03-13T16:23:30",
            "upload_time_iso_8601": "2024-03-13T16:23:30.372027Z",
            "url": "https://files.pythonhosted.org/packages/8f/e6/1f649e3fe4b6147f005f1f036ff3ef62b7d7ea1a2b4ed6c0cc20a0078569/nannos-2.6.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "867c9dbcb3020fadea4f38974e8aaf5b8c2b833bdf26c532d241e5e7694fd719",
                "md5": "275f1cf8eb3022770301dd41a7f93093",
                "sha256": "6e71708631080a56ca0294a9db13a3294dfb2bdae204a40eccbebb0340429259"
            },
            "downloads": -1,
            "filename": "nannos-2.6.2.tar.gz",
            "has_sig": false,
            "md5_digest": "275f1cf8eb3022770301dd41a7f93093",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 44585,
            "upload_time": "2024-03-13T16:23:32",
            "upload_time_iso_8601": "2024-03-13T16:23:32.247806Z",
            "url": "https://files.pythonhosted.org/packages/86/7c/9dbcb3020fadea4f38974e8aaf5b8c2b833bdf26c532d241e5e7694fd719/nannos-2.6.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-13 16:23:32",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "nannos",
    "gitlab_project": "nannos",
    "lcname": "nannos"
}
        
Elapsed time: 3.77863s