pyjamas-rfglab 2019.11.3

PyJAMAS is Just A More Awesome SIESTA

PyJAMAS

PyJAMAS is Just A More Awesome Siesta.

Installing PyJAMAS

The easiest way to install PyJAMAS is using PyPi.

A note on the Python interpreter

PyJAMAS requires that you have Python installed.

PyJAMAS has been extensively tested with with Python 3.6.6--Python 3.6.8. PyJAMAS can probably work well with other Python 3.6 releases prior to 3.6.6. However, we use type annotations, so Python versions prior to 3.6 will not work.

PyJAMAS does NOT work with Python >= 3.7. The reason for this is that PyJAMAS uses some tools from TensorFlow, a machine learning package, and TensorFlow is not yet friends with Python >= 3.7.

PyJAMAS does NOT work with Python 2.

If you are interested in using Python for your research, you should consider installing Anaconda, a scientific Python distribution. The most recent version of Anaconda (a scientific Python distribution) comes with Python >= 3.7. To downgrade to Python 3.6.8, you can open a terminal and type:

conda install python=3.6.8

MacOS and Linux

Open a terminal. If you had previously installed PyJAMAS, we recommend uninstalling the previous version:

pip uninstall pyjamas-rfglab

To install PyJAMAS, type:

pip install pyjamas-rfglab

To run PyJAMAS, type:

pyjamas

at the user prompt.

Windows

We recommend that, before installing PyJAMAS, you install Anaconda (a scientific Python distribution). In principle, the PyJAMAS PyPi package is self-contained, and will install all the necessary modules. However, in Windows there is an issue with Shapely, a package used in PyJAMAS to represent geometric objects such as points or polygons. Shapely is based on GEOS, a C++ library that comes with Anaconda but that fails to install with the PyJAMAS PyPi package. It is recommended to start by manually installing Shapely. To that end, download the appropriate Shapely version from this link. For example, use Shapely‑1.6.4.post1‑cp36‑cp36m‑win_amd64.whl for a 64-bit machine running Python 3.6. Open a command prompt and change into the folder that contains the downloaded .whl file using the cd command. Complete the installation of Shapely by typing:

pip install Shapely‑1.6.4.post1‑cp36‑cp36m‑win_amd64.whl

substituting the downloaded file name.

Once Shapely, has been set up, you can proceed with a regular PyPi installation of PyJAMAS. Just be sure to read our note on the interpreter above. After that, open a command prompt and type:

pip install pyjamas-rfglab

To run PyJAMAS type:

pyjamas

at the user prompt.