Installation

Prerequisites

Python 3.10.7
pip (modern version)

Installation

Standard Installation

Dyn-Core is available from a dedicated package repository. You can install it using pip:

pip install dyn-core

If you want to install the whole dyn suite, we recommend installing dyn-all`:

pip install dyn-all

Installation from Source

For users who want to access the latest development version or contribute to the project, you can install directly from the source repository:

# Clone the repository (SSH)
git clone git@gitlab.com:decide.imt-atlantique/dyn/core.git

# Or using HTTPS
git clone https://gitlab.com/decide.imt-atlantique/dyn/core.git

# Install in development mode
pip install -e /path/to/core

Using Virtual Environments

We recommend using virtual environments for installing Dyn-core to avoid conflicts with other packages.

Using venv:

python -m venv dyn-env
source dyn-env/bin/activate  # On Windows: dyn-env\Scripts\activate
# Then install the package as described above

Using pyenv with virtualenv:

pyenv install 3.10.7
pyenv virtualenv 3.10.7 dyn-env
pyenv local dyn-env
# Then install the package as described above

Using conda:

conda create -n dyn-env python=[3.10]
conda activate dyn-env
# Then install the package as described above

Verification

To verify your installation is working correctly, run the following Python code:

try:
    # Import the necessary components
    from dyn.core.communities import Tcommlist
    print("✓ Successfully imported the package")

except Exception as e:
    print(f"\n❌ Verification failed: {type(e).__name__}: {e}")
    print("Please check the troubleshooting section or report this issue.")

Troubleshooting

If you encounter issues during installation:

Ensure you’re using a compatible Python version
Check that you have the necessary permissions to install packages
If behind a proxy, configure pip appropriately
For further assistance, please consult the troubleshoots document or create an issue on our GitLab repository