Skip to main content

pyGDM2 is available on pypi and gitlab.

Detailed documentation with many examples is avaiable at the pyGDM2 documentation website. See also the documentation paper on arXiv (1802.04071)

Requirements

Python

  • python (2.7 or 3.5+, python)

  • numpy (numpy)

  • python headers (under ubuntu, install the package python-dev or python-devel)

Fortran

  • fortran compiler (tested with gfortran. gcc)

  • openmp (openmp)

  • f2py (comes with numpy. link)

Optional Python packages

  • scipy >= v0.17.0, lower versions supported with restrictions (Strongly recommended. Used for standard solver LU decomposition and several tools. scipy)

  • matplotlib (Strongly recommended. For all 2D visualization tools. matplotlib)

  • mpi4py (for MPI parallelized calculation of spectra. mpi4py)

  • mayavi (for all 3D visualization. mayavi)

  • PIL (image processing. PIL)

  • pathos (for multi-threaded generalized propagator operations. pathos)

  • pytables (v3.x recommended. For hdf5 saving/loading of simulations. pytables)

  • PaGMO / PyGMO (version 2.4+. Required for the EO submodule. pagmo)

(all available via pip)

Installation under linux

Via pip

Install from pypi repository via

$ pip install pygdm2

Via setup script

The easiest possibility to compile (and install) pyGDM is via the setup-script, which uses the extended distutils from numpy.

To install pyGDM, run in the source directory:

$ python setup.py install

To install to a user-defined location, use the prefix option:

$ python setup.py install --prefix=/some/specific/location

To only compile without installation, use

$ python setup.py build

Manual compilation

  1. clone git:

    $ git clone https://gitlab.com/wiechapeter/pyGDM2.git
  2. compile fortran parts:

    $ cd fortranBase
    $ make
  3. optional, for system-wide usage add to path and pythonpath, e.g. add following lines to file “/home/USER/.profile”, where “path_of_pyGDM_folder” is the pyGDM installation directory:

    PATH="path_of_pyGDM_folder:$PATH"
    export PATH
    
    PYTHONPATH="path_of_pyGDM_folder:$PYTHONPATH"
    export PYTHONPATH

Installation under Mac OS X

Using the Anaconda distribution

The default compiler on OSX uses a clang which does not support OpenMP. Hence compilation might fail. We therefore suggest using Anaconda and install gcc from the conda repository in a virtualenv (Here the example of python2. python3 was not tested on OSX so far):

$ conda create -n python2 python=2.7 anaconda

“anaconda” at the end will copy the whole anaconda distribution to the virtial env. You can omit this option and create a “blank” virtual environment to install only selected packages.

Next activate the virtualenv and install the required software:

$ source activate python2
$ xcode-select --install
$ conda install pip
$ conda install gcc
$ pip install pygdm2

Also make sure you have the latest versions of numpy and scipy:

$ pip install numpy scipy --upgrade

Without Anaconda

Alternatively, you can download the latest version and compile it manually without OpenMP support, which should work with the default OSX compiler:

$ python setup.py install --no-openmp

Installation under windows

For windows, we also recommend Anaconda in which pyGDM can be installed easily via pip. See also the MacOS X instructions, but you can skip all steps for installing the gcc compilers, since the windows version of pyGDM comes as pre-compiled binary package.

Via pip

There is a binary for 64bit windows on the pypi repository (tested on Win7 and Win10). Install via

$ pip install pygdm2

Compile using the Anaconda distribution (tested with anaconda3)

  1. get the repo (e.g. download from gitlab)

  2. install gcc compiler

    $ conda update conda
    $ conda install m2w64-toolchain libpython
  3. compile fortran parts:

    $ python setupy.py build
  4. install:

    $ python setupy.py install

Authors

Python code

  • P. R. Wiecha

Fortran code

  • C. Girard

  • A. Arbouet

  • R. Marty

  • P. R. Wiecha

Release files for pyGDM2 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyGDM2 1.0.6
File Size Uploaded
pyGDM2-1.0.6.tar.gz 437.6 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for pyGDM2 1.0.6
File
pyGDM2-1.0.6-py3.5-linux-x86_64.egg Legacy Egg format - - Details
pyGDM2-1.0.6-py2.7-linux-x86_64.egg Legacy Egg format - - Details
pyGDM2-1.0.6-cp37-cp37m-win_amd64.whl CPython 3.7 CPython 3.7 pymalloc Windows x86-64 Details
pyGDM2-1.0.6-cp36-cp36m-win_amd64.whl CPython 3.6 CPython 3.6 pymalloc Windows x86-64 Details
pyGDM2-1.0.6-cp35-cp35m-win_amd64.whl CPython 3.5 CPython 3.5 pymalloc Windows x86-64 Details
pyGDM2-1.0.6-cp27-cp27m-win_amd64.whl CPython 2.7 CPython 2.7 pymalloc Windows x86-64 Details

Total release size: 2.8 MB

Release files / pyGDM2-1.0.6.tar.gz

Download URL pyGDM2-1.0.6.tar.gz
Size 437.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0cf7450d7e4a3f594a4ec97f9b288f1387236ce52499953921442226439f2b87
BLAKE2b-256 checksum
How to use checksums
3a0521628940613d9b3bc01b2e4bd4d5f1d1b50390c866bd205751ddb32b2fcc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.12

Release files / pyGDM2-1.0.6-py3.5-linux-x86_64.egg

Download URL pyGDM2-1.0.6-py3.5-linux-x86_64.egg
Size 451.5 kB
Tags Egg
SHA-256 checksum
How to use checksums
756b2e8d2825fdcdd100f835de1f0808db0b4f593425fa90c8ef9774300df49d
BLAKE2b-256 checksum
How to use checksums
7b83888d594d5189768cfdf2037ee9e6bf24a8f24b6f7e6e33ac4ef97f8bfb71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.12

Release files / pyGDM2-1.0.6-py2.7-linux-x86_64.egg

Download URL pyGDM2-1.0.6-py2.7-linux-x86_64.egg
Size 444.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
faf298f7d9a9adb24fe3083683dbc26f7fd87a82e322cecdfdd0ff30a0164421
BLAKE2b-256 checksum
How to use checksums
1dfe9c4c386a0d35dc9bcc50d231d42e0700a8354c2b264945fcedd30d1b6ffa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.12

Release files / pyGDM2-1.0.6-cp37-cp37m-win_amd64.whl

Download URL pyGDM2-1.0.6-cp37-cp37m-win_amd64.whl
Size 356.9 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
0ea8900bd2a6ec7f6d78ce7bad6fe554d30f81817773323b8e1f440f85aee2aa
BLAKE2b-256 checksum
How to use checksums
519d5e5b50a0b97f5e7d7d6701f205f69b10a264ce6fd190dbc6d9d1a2b26849
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

Release files / pyGDM2-1.0.6-cp36-cp36m-win_amd64.whl

Download URL pyGDM2-1.0.6-cp36-cp36m-win_amd64.whl
Size 368.3 kB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
06545549a31809edbb4475eac97167a728ea125fec214c141e1e530f321b15c8
BLAKE2b-256 checksum
How to use checksums
27938d23436b9006e2acee47dad2ba8d46b7bb9b7621545760c38d7bb892c407
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

Release files / pyGDM2-1.0.6-cp35-cp35m-win_amd64.whl

Download URL pyGDM2-1.0.6-cp35-cp35m-win_amd64.whl
Size 356.3 kB
Tags CPython 3.5 CPython 3.5 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
bacb46f62f52900f10e8207f13a4c33abc71d169305782cea8407ffc1ace0b80
BLAKE2b-256 checksum
How to use checksums
56776d8d161487896bb284e7a534969a77ceb79d8e6db674da4eae38b54ea875
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.6

Release files / pyGDM2-1.0.6-cp27-cp27m-win_amd64.whl

Download URL pyGDM2-1.0.6-cp27-cp27m-win_amd64.whl
Size 365.4 kB
Tags CPython 2.7 CPython 2.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
2ea7d880b757a20d3bb39d4b6566b1978e3834959b6f05a350570f64cf7622e7
BLAKE2b-256 checksum
How to use checksums
6361868355b1951b8e2f935dff50be4f4e84263d72c195c3dd16a1df5aaa27bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page