1. Installation instructions

1.1. Installing fancytypes

For all installation scenarios, first open up the appropriate command line interface. On Unix-based systems, you would open a terminal. On Windows systems you would open an Anaconda Prompt as an administrator.

1.1.1. Installing fancytypes using pip

The easiest way to install fancytypes using pip is to run the following command:

pip install fancytypes

The above command will install the latest stable version of fancytypes.

To install the latest development version from the main branch of the fancytypes GitHub repository, one must first clone the repository by running the following command:

git clone https://github.com/mrfitzpa/fancytypes.git

Next, change into the root of the cloned repository, and then run the following command:

pip install .

Note that you must include the period as well. The above command executes a standard installation of fancytypes.

Optionally, for additional features in fancytypes, one can install additional dependencies upon installing fancytypes. To install a subset of additional dependencies (along with the standard installation), run the following command from the root of the repository:

pip install .[<selector>]

where <selector> can be one of the following:

• tests: to install the dependencies necessary for running unit tests;

• examples: to install the dependencies necessary for running the jupyter notebooks stored in <root>/examples, where <root> is the root of the repository;

• docs: to install the dependencies necessary for documentation generation;

• all: to install all of the above optional dependencies.

1.1.2. Installing fancytypes using conda

To install fancytypes using the conda package manager, run the following command:

conda install -c conda-forge fancytypes

The above command will install the latest stable version of fancytypes.

1.2. Uninstalling fancytypes

If fancytypes was installed using pip, then to uninstall, run the following command from the root of the repository:

pip uninstall fancytypes

If fancytypes was installed using conda, then to uninstall, run the following command from the root of the repository:

conda remove fancytypes