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

You need Python 3.10 or later to run pywerami. The package requires NumPy and SciPy, and the plotting routines require Matplotlib.

It is suggested to install pywerami to isolated environment.

Create a Virtual Environment

Open any terminal and run below command:

python -m venv venv

Activate the virtual environment. For Linux based OS or macOS:

source venv/bin/activate

For Windows with cmd:

.\venv\Scripts\activate.bat

For Windows with Power shell:

.\venv\Scripts\activate.ps1

To install astropy from PyPI, use:

pip install pywerami

Using conda/mamba

For (virtualenv or conda) Another recommended way is to use Miniforge, the minimal installers for Conda and Mamba specific to conda-forge, with the pre-configured conda-forge channel as the default (and only) channel.

To create own isolated environment, open Miniforge terminal and run.

mamba create -y -n pywerami python>=3.10 pyqt=5 numpy matplotlib scipy

Activate the environment:

mamba activate pywerami

and install pywerami:

pip install pywerami

To start pywerami, simply type:

pywerami

Do not forget that virtuakl environment must be activated prior running pywerami.

Getting help

If you get any errors open a new Issue providing the versions from either command above, as well as any errors you saw in the console during the installation.

Donate

pywerami is an open-source project, available for you for free. It took a lot of time and resources to build this software. If you find this software useful and want to support its future development please consider donating me.

Donate via PayPal

License

pywerami is free software: you can redistribute it and/or modify it under the terms of the MIT License. A copy of this license is provided in LICENSE file.

About

Process contour data file generated by the Perple_X program WERAMI

Resources

License

Stars

Watchers

Forks

Packages

No packages published