Skip to content

Latest commit

 

History

History
43 lines (38 loc) · 2.19 KB

README.md

File metadata and controls

43 lines (38 loc) · 2.19 KB

Building the Fortran part of this project requires a Fortran compiler such as gfortran.

Building the Python part of this project requires Python 3 (tested with Python 3.9) and some packages from PyPI. The recommended way to install these packages is by using pip in a virtualenv. You can create a virtualenv to the current folder by running python3 -m venv venv. Then you can activate it with source ./venv/bin/activate on Linux and by running the corresponding PowerShell script on Windows. Now both the commands python and python3 should point to the Python 3 installation of the virtualenv in the current shell session. When the virtualenv has been set up, the packages can be installed by running pip install -r requirements.txt when in the src folder. Alternatively you can use an IDE such as PyCharm, which will take care of the virtualenv and libraries for you. However, since the requirements.txt is not at the root of this project, you may have to set its location manually in the settings at Tools → Python Integrated Tools → Packaging → Package requirements file.

When the all the dependencies have been installed, the project can be built by running make all. (Personally I would prefer to use a bash script instead, but the use of make is said to give bonus points.) The GitHub Actions workflow files can be used as an additional template on how to build the project.

There are also precompiled binaries available on GitHub, but running the Python code requires the installation of the necessary libraries regardless.