Working on an HPC

While HPCs won’t let you install packages globally, you can still use aurel. You just need to create a virtual environment and install aurel there.

Create a virtual environment

Create a virtual environment and activate it.

python -m venv ~/myenv
source ~/myenv/bin/activate

Then you should be able to do:

pip install aurel

or the latest development version.

You should be able to find the package in myenv/lib/pythonX.X/site-packages/aurel. Accompanying required packages will be installed automatically, but at this point you should also install any other python packages you typically use.

Jupyter notebook

If you want to use aurel in a jupyter notebook, while your environment is active, add your virtual environment as a Jupyter kernel

python -m ipykernel install --user --name=myenv --display-name "Python (myenv)"

Now you can load your jupyter notebook, select the kernel you just created Python (myenv) and type in your notebook:

import aurel

Python script

If you want to use aurel in a python script, before running it, activate the environment

source ~/myenv/bin/activate
python myscript.py

then in your python script you can have

import aurel

Convergence

See Schwarzschild check

Choose the order of the finite difference scheme you want to use, this is done by setting the fd_order parameter in the aurel.FiniteDifference class. Options are: 2, 4 (default), 6, 8.

fd = aurel.FiniteDifference(param, fd_order=6)

Increase the grid resolution in your simulation, or reduce the grid spacing for generated data.