Installation#
Requirements#
cygrid has the following strict requirements:
Installing cygrid#
Using Anaconda#
The easiest way to install cygrid is certainly to make use of the
great Anaconda Python distribution:
conda install cygrid -c conda-forge
Using pip#
To install cygrid with pip, simply run
python -m pip install cygrid
Note
You may need a C++ compiler (e.g., g++) with OpenMP support to be
installed for the installation to succeed, if no binary wheel is available for your OS and Python version
on the Python Package Index
Note
Use the --no-deps flag if you already have dependency packages
installed, since otherwise pip will sometimes try to “help” you
by upgrading your installation, which may not always be desired.
Note
If you get a PermissionError this means that you do not have the
required administrative access to install new packages to your Python
installation. In this case you may consider using the --user option
to install the package into your home directory, or even better work
with virtual environments!
We recommend to use a Python distribution, such as Anaconda, especially, if you are on Installation on Windows.
Do not install cygrid or other third-party packages using sudo
unless you are fully aware of the risks.
Installation from source#
There are two options, if you want to build cygrid from sources. Either, you
install the tar-ball (*.tar.gz file) from PyPI and extract it to the directory of
your choice, or, if you always want to stay up-to-date, clone the git
repository:
git clone https://github.com/bwinkel/cygrid
Then go into the cygrid source directory and run:
python -m pip install .
Again, consider using virtual environments or even better use a python distribution such as Anaconda to avoid messing up the system-wide Python installation.
Installation on Windows#
Note that for Windows machines we provide binary wheels via PyPI and installation is as easy as with Linux:
python -m pip install cygrid
Note
If you are desperate, you can install cygrid from source even on Windows. You’ll need to install a suitable C-compiler; see here.
Installation on MacOS#
Installation on MacOS can be a bit tricky, because the standard C compiler does not support OpenMP. We provide wheels on PyPI, such that you can
python -m pip install cygrid
however, depending on the C++ compiler used on your system you may still get into trouble. We can’t provide support for this.
Testing an installed cygrid#
The easiest way to test if your installed version of cygrid is running
correctly, is to use the test() function:
import cygrid
cygrid.test()
The tests should run and print out any failures, which you can report at the cygrid issue tracker.
Note
This way of running the tests may not work if you do it in the cygrid source distribution directory.
If you prefer testing on the command line and usually work with the source code, you can also do (outside of project directory)
python -m pytest --pyargs cygrid