How to install magnopy#

Requirement for magnopy installation are

And several third-party libraries

# Package dependencies
numpy
wulfric>=0.6.3,==0.6.*

# Optional package dependencies [visual]
matplotlib
plotly
wulfric[visual]>=0.6.3,==0.6.*

Magnopy can be installed with pip or from source.

Do you have Python?#

Most likely Python is already installed on your machine (if not check Python installation). One of the ways to check if you have python installed is to run the command in your terminal

python

If you see something like

Python 3.13.5 (main, Jun 11 2025, 15:36:57) [Clang 15.0.0 (clang-1500.1.0.2.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>>

then you have it.

In most cases python command launches python3, however if it launches python2, then you may need to use python3 instead (and pip3 instead of pip).

Hint

Use exit() or press ctrl+D to close python console.

Hint

On linux and OSX systems one can create a virtual environment for the magnopy's installation with (use your version of python instead of python3.13 if needed)

python3.13 -m venv .venv

And activate it with

source .venv/bin/activate

Installation with pip#

Magnopy is published and distributed via Python package index. To install it use the command (you may need to use pip3)

pip install magnopy

Hint

If you execute

magnopy

and see something like

usage: magnopy [-h] [-v] [{logo,warranty} ...]

███╗   ███╗  █████╗   ██████╗  ███╗   ██╗  ██████╗  ██████╗  ██╗   ██╗
████╗ ████║ ██╔══██╗ ██╔════╝  ████╗  ██║ ██╔═══██╗ ██╔══██╗ ╚██╗ ██╔╝
██╔████╔██║ ███████║ ██║  ███╗ ██╔██╗ ██║ ██║   ██║ ██████╔╝  ╚████╔╝
██║╚██╔╝██║ ██╔══██║ ██║  ╚██║ ██║╚██╗██║ ██║   ██║ ██╔═══╝    ╚██╔╝
██║ ╚═╝ ██║ ██║  ██║ ╚██████╔╝ ██║ ╚████║ ╚██████╔╝ ██║         ██║
╚═╝     ╚═╝ ╚═╝  ╚═╝  ╚═════╝  ╚═╝  ╚═══╝  ╚═════╝  ╚═╝         ╚═╝
                                                           ▄   ▄
                      Version: 0.4.0                       █▀█▀█
                Documentation: magnopy.org                 █▄█▄█
              Release date: 23 October 2025                 ███   ▄▄
                    License: GNU GPLv3                      ████ █  █
          Copyright (C) 2023-2025  Magnopy Team             ████    █
                                                            ▀▀▀▀▀▀▀▀

Available scripts are:

* magnopy-optimize-sd

* magnopy-lswt

To call for help for each script type <script name> --help
Information below is relevant only to 'magnopy' command.

positional arguments:
  {logo,warranty}  command/commands on what to do. Use to display some
                   information about package.

options:
  -h, --help       show this help message and exit
  -v, --version    print version of magnopy

then the installation worked and magnopy is ready to use.

If there are any bugs with the installation, please drop a message to the developers through one of our support channels and we would be happy to help.

Optionally, if you want magnopy to be able to produce .png and .html files you can install Plotly and matplotlib manually or install them as magnopy's dependencies

pip install magnopy[visual]

Note

You may need to escape the [ and ] characters, because they are special characters in most shells. For example, in bash you can use backslash

pip install magnopy\[visual\]

Or enclose full name in quotes

pip install "magnopy[visual]"

Hint

If you are using jupyter lab or notebook, then magnopy can be installed as

%pip install magnopy

or

%pip install "magnopy[visual]"

within it. You may need to have to restart you kernel as well.

Installation from source#

Source code of magnopy is publicly available (see Magnopy repository), therefore magnopy can be installed from source.

  • Clone the project (in other words, download the source code)

    git clone git@github.com:magnopy/magnopy.git

  • Change the directory

    cd magnopy

  • Install the requirements (you may need to use pip3)

    pip install -r requirements.txt

  • To install magnopy, run (you may need to use pip3)

    pip install .

    or

    pip install ".[visual]"

Update#

New versions of magnopy are often published. We recommend to update from time to time to get the new features and bug fixes.

To update magnopy to the latest available version (0.4.3) use the command (you may need to use pip3)

pip install magnopy --upgrade

or

pip install "magnopy[visual]" --upgrade