Skip to content

Process contour data file generated by the Perple_X program WERAMI

License

Notifications You must be signed in to change notification settings

ondrolexa/pywerami

Repository files navigation

pywerami

GitHub version Documentation Status DOI

What is pywerami

pywerami is a stand-alone program to make an countour/3D plot from data file generated by the Perple_X program WERAMI or tci file generated by TCInvestigator.

Installation

pywerami can be installed as a Python package on Windows, Linux, Mac OS X, and Mac OS Apple Silicon.

You need Python 3.6 or later to run pywerami. The package requires NumPy and SciPy, and the plotting routines require Matplotlib, so we strongly recommend using Miniforge to install it in its own isolated environment.

The newest version of pywerami can always be found in the Releases page.

Installation requires entering commands in a terminal. To open one:

Windows: Open the Start menu and search for the Miniforge Prompt (if using Miniforge) or the Command Prompt if not.

Linux: Launch a new terminal by pressing Ctrl + Alt + T.

Mac: Launch a new terminal by pressing Cmd + Space and searching for Terminal.

Installing Miniforge

Miniforge is the minimal installers for Conda and Mamba specific to conda-forge, with the pre-configured conda-forge channel as the default (and only) channel.

If you already have Anaconda on your computer, then you can set the solver to libmamba in the base environment (and skip the Miniforge installation):

conda update -n base conda
conda install -n base conda-libmamba-solver
conda config --set solver libmamba
Any subsequent `mamba` commands in the docs will need to be replaced with `conda` if you choose to use your existing Anaconda installation.

Otherwise, to install Mamba:

On Windows, just click through the installation steps.

  1. Go to: https://github.com/conda-forge/miniforge#download
  2. Download the latest version for your OS.
  3. Follow the installer instructions.

We recommend using the following settings:

  • Install for: All Users (requires admin privileges)
  • Destination folder: e.g. C:\mambaforge, do not use folders with space character on the path like C:\Program Files\mambaforge or containing special national characters.

On Linux, it might be easier to do this straight from the terminal (Ctrl + Alt + T) with this one-liner:

wget -nc https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-Linux-x86_64.sh && bash Mambaforge-Linux-x86_64.sh -b && ~/mambaforge/bin/conda init bash

Restart the terminal after running this command.

For other Linux architectures (arm64 and POWER8/9), replace the .sh filenames above with the correct installer name for your architecture. See the Download column in this table for the correct filename.

On Macs (pre-M1), you can run the installer using this terminal command:

wget -nc https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-x86_64.sh && bash Miniforge3-MacOSX-x86_64.sh -b && ~/mambaforge/bin/conda init zsh

On Macs (Apple Silicon), use this terminal command:

curl -fsSL --compressed https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-arm64.sh -o Miniforge3-MacOSX-arm64.sh && chmod +x Miniforge3-MacOSX-arm64.sh && ./Miniforge3-MacOSX-arm64.sh -b -p ~/mambaforge && rm Miniforge3-MacOSX-arm64.sh && ~/mambaforge/bin/conda init "$(basename "${SHELL}")" && source "$HOME/.$(basename "${SHELL}")rc"

Installation methods

<