Skip to content
Snippets Groups Projects
Commit 41ee1eeb authored by Tor-Einar Skog's avatar Tor-Einar Skog
Browse files

Docs update

parent 4c3eb148
Branches
No related tags found
No related merge requests found
......@@ -3,6 +3,8 @@
## How to find and instantiate this model
TODO: Must find a way of dynamically importing models
Clues here: https://stackoverflow.com/questions/42401495/how-to-dynamically-import-modules#42402095
``` python
>>> from reference_model import reference_model
>>> from vipscore_common.vips_model import VIPSModel
......@@ -18,4 +20,16 @@ TODO: Must find a way of dynamically importing models
>>> t.get_model_description()
"\n The model is a reference model for developers, showcasing best practices and functionalities of a model.\n It's a simple day degree model for an imagined pest, and when thresholds are passed, the warning status progresses.\n "
```
\ No newline at end of file
```
## Testing
The tests are located in the `tests` folder, and we're using [Pytest](https://docs.pytest.org/)
To run the unit tests, move to the root folder of the project, and execute:
``` bash
pytest -v
```
## References
We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment