pyjamas-rfglab 2021.3.1

PyJAMAS is Just A More Awesome SIESTA

PyJAMAS

PyJAMAS is Just A More Awesome Siesta.

Documentation

You can find the official PyJAMAS documentation here.

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 Python 3.6, 3.7 and 3.8.

We use type annotations, which were introduced in Python 3.6, so PyJAMAS will not work with Python versions prior to 3.6.

For Linux users, we strongly suggest using the most recent version of Python 3.8, which solves incompatibilities with Theano, a machine learning package used in PyJAMAS.

PyJAMAS does NOT work with Python 2.

MacOS and Linux

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

To install PyJAMAS, type:

python3 -m pip install --no-cache-dir -U pyjamas-rfglab

To run PyJAMAS, type:

pyjamas

at the user prompt.

If the executable fails to run, you can also try to execute PyJAMAS by opening a terminal and typing:

python3 -m pyjamas.pjscore

Alternatively, if you clone this repository, you can run PyJAMAS by opening a terminal and navigating to the folder that contains the code using the cd command. Once in the folder, type:

python3 pjscore.py

Windows

Before installing PyJAMAS, you will need to install Shapely, a package used in PyJAMAS to represent geometric objects such as points or polygons. Under Windows, Shapely 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.post2‑cp37‑cp37m‑win_amd64.whl for a 64-bit machine running Python 3.7. Open a command prompt and navigate to the folder that contains the downloaded .whl file using the cd command. Complete the installation of Shapely by typing:

python -m pip install Shapely‑1.6.4.post2‑cp37‑cp37m‑win_amd64.whl

substituting the downloaded file name.

Once Shapely, has been set up, you can proceed with a regular PyPi installation of PyJAMAS. Open a command prompt and type:

python -m pip install --no-cache-dir -U pyjamas-rfglab

To run PyJAMAS type:

pyjamas

at the user prompt.

If the executable fails to run, you can also try to execute PyJAMAS by opening a command prompt and typing:

python -m pyjamas.pjscore

Alternatively, if you clone this repository, you can run PyJAMAS by opening a command prompt and navigating to the folder that contains the code using the cd command. Once in the folder, type:

python pjscore.py