Welcome to pyBMF_Analyse’s documentation!

How to install pyBMF_Analyse

It is recommanded to install python using a virtual environment like conda : https://docs.conda.io/projects/miniconda/en/latest/

Check the option :

  • [X] Add miniconda3 to my PATH environment variable

_images/anaconda-01.png _images/anaconda-02.png _images/anaconda-03.png

Open a terminal and type :

# Creation of the virtual python environment
conda create -n jupyter python
# Activation of the virtual python environment
conda activate jupyter
# Setting pip to use the pybmf_analyse package registry
pip config --user set global.index-url https://git.unistra.fr/api/v4/projects/38356/packages/pypi/simple
# Installation of pybmf_analyse with pip
pip install pybmf-analyse

later to upgrade pyBMF_Analyse package :

conda activate jupyter
pip install pybmf-analyse --upgrade
# or
pip install pybmf-analyse -U

then you can use jupyter lab (prefered), open a terminal :

conda activate jupyter
jupyter lab

or jupyter notebook

conda activate jupyter
jupyter notebook

For a desktop shortcut creation:

  • Create shortcut: right click on desktop, New ‣ Shortcut

  • Paste the following command into the field location of the item:

For Jupyter lab:

%windir%\System32\cmd.exe "/K" cd C:\Users\%username% && C:\Users\%username%\Miniconda3\Scripts\activate.bat C:\Users\%username%\Miniconda3\envs\jupyter & jupyter lab && exit

For Jupyter notebook:

%windir%\System32\cmd.exe "/K" cd C:\Users\%username% && C:\Users\%username%\Miniconda3\Scripts\activate.bat C:\Users\%username%\Miniconda3\envs\jupyter & jupyter notebook && exit

Releases

https://git.unistra.fr/bmf/pybmf_analyse/-/releases

Package registry

https://git.unistra.fr/bmf/pybmf_analyse/-/packages

Package documentation

Indices and tables