Metadata-Version: 2.4
Name: nanite-community
Version: 0.1.1
Summary: Repository for storing nanite models
Author-email: Eoghan O'Connell <eoclives@hotmail.com>, Paul Müller <dev@craban.de>
License: MIT
Keywords: AFM,Atomic Force Microscopy,Hertz KVM,nanite,pyjibe
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lmfit>=1.3.2
Requires-Dist: numpy==1.26.*
Dynamic: license-file

# Nanite Community Models

This is a repository for storing
[nanite](https://github.com/AFM-Analysis/nanite) models. These can be models
that exist as part of a publication, or not. Storing them here will make them
easy to use in nanite and PyJibe.

## Future Plans

We soon plan to incorporate this package into the
[nanite](https://github.com/AFM-Analysis/nanite) package so that all
models are available as an optional dependency.

## Contributing

If you wish to add a model to this repository and are not familiar with git
and github, please make a new Issue.
Then, place the model code in a single python file as described in the
[nanite docs here](https://nanite.readthedocs.io/en/stable/sec_develop.html#writing-model-functions).
Then, fork this repository, make a Pull Request and choose a reviewer.
