"A program for calculating and plotting positron cross sections."
Project description
Positron Cross Section Analysis
This is a python application that assists with the analysis and plotting of positron cross sections
Installation
To install the positron cross section application, ensure that you have python version 3.7 or greater
python --version
and then install with
python -m pip install --upgrade pip
python -m pip install positron-cross-section
You can then run the application using the command
positron-cross-section cross_section_data.csv
which will produce total cross section plots in the output folder.
Development environment installation instructions
Setting up Python Environment
The python code in this application requires a development environment with python 3.9 or greater. To maintain the integrity of other python applications on your system, it is highly recommended to use a separate python environment for the positron cross section application, however it can also be installed directly if your python version meets the requirements.
Installing a python environment
To set up a separate python environment (recommended), we will use pyenv which allows us to isolate the positron cross section development environment and python version. To install pyenv, please follow the instructions detailed here. During this installation, you will get the warning
WARNING: seems you still have not added 'pyenv' to the load path.
# Load pyenv automatically by adding
# the following to ~/.bashrc:
To add this text to ~./bashrc, run the command
echo 'export PATH="$HOME/.pyenv/bin:$PATH"
export PATH="$HOME/.pyenv/shims:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"' >> ~/.bashrc
You now need to reload your shell which can be done by restarting your terminal or running the command
exec $SHELL
To create a pyenv environment called positrons for this application with python version 3.9.5, run the commands
pyenv install 3.9.5
pyenv virtualenv 3.9.5 positrons
Then, prior to following the installation steps below and before each time using the positron-cross-section application, you will need to enter the positrons python environment using the command
pyenv activate positrons
Downloading and installing the positron cross section application
To download the source code and install the application, please open a terminal, navigate to the folder in which you would like to perform the installation and run the commands
git clone https://github.com/ryanstocks00/positron-cross-section
cd positron-cross-section
source tools/install-dev-env
Congratulations! The poistron cross section application is now (hopefully) successfully installed and can be run using the command
positron-cross-section --help
in a new terminal window.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for positron_cross_section-0.0.42.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc2edfdac06d9f99847abc69b0ff604b2324e87da03696167ff6bc98a57ad666 |
|
MD5 | 3893c65fcccb2c06a53cf45baa89ff40 |
|
BLAKE2b-256 | fb2de71f7daf4e15601a257e48600a14b023021d2cda96ad81f60a7a3bba770d |
Hashes for positron_cross_section-0.0.42-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8ffb1fe573b7391e25410ec83249624244cb5048d1e2440f94cfc56ad1347ee |
|
MD5 | cd5e9f16e9315cc8ad13a63e088f8d60 |
|
BLAKE2b-256 | 1cbec32331f9695287c265ca2a8ba6aa6f9003d219fdb78ca49162daef2c9eaa |