Metadata-Version: 2.1
Name: nanomesh
Version: 0.5.0
Summary: Creates 3d meshes from microscopy experimental data
Home-page: https://github.com/hpgem/nanomesh
Author: Nicolas Renaud
Author-email: n.renaud@esciencecenter.nl
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/hpgem/nanomesh/issues
Description: [![Documentation Status](https://readthedocs.org/projects/nanomesh/badge/?version=latest)](https://nanomesh.readthedocs.io/en/latest/?badge=latest)
        [![Linux](https://github.com/hpgem/nanomesh/actions/workflows/test_on_linux.yml/badge.svg)](https://github.com/hpgem/nanomesh/actions/workflows/test_on_linux.yml)
        [![MacOS](https://github.com/hpgem/nanomesh/actions/workflows/test_on_macos.yaml/badge.svg)](https://github.com/hpgem/nanomesh/actions/workflows/test_on_macos.yaml)
        [![Windows](https://github.com/hpgem/nanomesh/actions/workflows/test_on_windows.yaml/badge.svg)](https://github.com/hpgem/nanomesh/actions/workflows/test_on_windows.yaml)
        
        ![Nanomesh banner](./notebooks/banner/banner.png)
        
        # nanomesh
        
        Creates 3d meshes from microscopy experimental data.
        
        Documentation: https://nanomesh.readthedocs.io/en/latest/
        
        ## Installation
        
        If you use conda, create a new environment:
        
        ```
        conda create -n nanomesh python=3.8
        conda activate nanomesh
        ```
        
        Install nanomesh:
        
        ```
        pip install nanomesh
        ```
        
        For the full installation instructions, see the [documentation](https://nanomesh.readthedocs.io/en/latest/).
        
        ### Development
        
        Install `nanomesh` using the development dependencies:
        
        `pip install -e .[develop] -c constraints.txt`
        
        Running the tests:
        
        `pytest`
        
        Linting/checks:
        
        `pre-commit`
        
        Building the docs:
        
        ```
        make html --directory docs
        ```
        
Keywords: materials-science,mesh-generation,microscopy
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Provides-Extra: develop
Provides-Extra: publishing
