Usage
=====

Installation
------------

To use Nephosem, clone the `repository`_ and append it to the path in your Python scripts:

.. code-block:: python

    import os
    os.path.append("/path/to/repository")
    import nephosem

.. _repository: https://github.com/QLVL/nephosem/

The "/path/to/repository" is the path leading to the cloned repository, which by default will be called
`nephosem`. It will have a subdirectory `nephosem` inside, which has the code per se.

Citation
--------

If you use this code, use the information below:

.. .. literalinclude:: ../../CITATION.cff
..    :language: cff

.. code-block:: bibtex

    @software{QLVL_nephosem,
        author = {{QLVL}},
        doi = {10.5281:zenodo.5710426},
        license = {GPL-3.0-or-later},
        title = {{nephosem}},
        version = {0.1.0}
    }