Installation
============
Prerequisites
-------------
``radioactivedecay`` requires Python 3.8+ and the `Matplotlib
`_, `NetworkX
`_, `NumPy `_,
`Pandas `_,
`SciPy `_,
`Setuptools `_ and
`SymPy `_ packages. These can be
installed from `python.org `_ and `PyPI
`_, or via a package manager such as `Anaconda
`_, `WinPython `_,
`MacPorts `_, `HomeBrew `_,
`APT `_ etc.
Installation
------------
The easiest ways to install ``radioactivedecay`` are via the `Python Package
Index `_ using ``pip``:
.. code-block:: bash
$ pip install radioactivedecay
or via `conda-forge `_:
.. code-block:: bash
$ conda install -c conda-forge radioactivedecay
Either command will attempt to install the dependencies (Matplotlib, NetworkX,
NumPy, Pandas, SciPy, Setuptools & SymPy) if they are not already present in
the environment.
It is also possible to clone the GitHub `repository
`_ and install from within the
``radioactivedecay`` directory using:
.. code-block:: bash
$ pip install -e .
Testing
-------
``radioactivedecay`` includes code tests using the unittest framework. To run
the tests, first git clone the repository from `GitHub
`_:
.. code-block:: bash
$ git clone https://github.com/radioactivedecay/radioactivedecay.git
then execute:
.. code-block:: bash
$ cd radioactivedecay
$ python -m unittest discover
Uninstallation
--------------
You can uninstall ``radioactivedecay`` by:
.. code-block:: bash
$ pip uninstall radioactivedecay
or if installed originally via ``conda``:
.. code-block:: bash
$ conda uninstall radioactivedecay