Skip to main content

Numerical model for life history evolution of age-structured populations

Project description

PyPI version Python 3.6+

AEGIS

Aging of Evolving Genomes In Silico (AY-jis, /eɪd͡ʒɪs/)

Numerical model for life history evolution of age-structured populations under customizable ecological scenarios.

How to install

We recommend that you install aegis-sim from PyPI into a virtual environment.

$ pip install aegis-sim
Cheat sheet
# Unix/macOS
python3 -m venv aegis-venv
. aegis-venv/bin/activate
python3 -m pip install aegis-sim
# Windows
python -m venv aegis-venv
.\aegis-venv\Scripts\activate
python -m pip install aegis-sim
For developers
# Unix/macOS
git clone git@github.com:valenzano-lab/aegis.git
cd aegis
make install_dev

To check if installation is successful, run aegis -h. If it is, the output will contain Aging of Evolving Genomes In Silico; if not, it will say aegis: command not found.

How to run

  1. Create a configuration file

    Before running a custom AEGIS simulation, you must create a configuration file (in YAML format) which will contain your custom parameter values. List of modifiable parameters, and all relevant details can be found in the wiki. Default parameter values are set in the file default.yml.

    An example of a YAML file:

    # custom.yml
    
    RANDOM_SEED_: 42
    STAGES_PER_SIMULATION_: 10000
    MAX_LIFESPAN: 50
    
  2. Start the simulation

    $ aegis {path/to/file}.yml # In this case, `aegis custom.yml`
    
  3. Inspect the output

    Output files will be created in the {path/to/file} directory (in this case, in the custom directory) which will have the following structure:

    {path/to/file}/
        progress.log
        {ecosystem-number}/
            output-summary.json
            snapshots/
                demography/
                    {stage}.feather
                    ...
                genotypes/
                    {stage}.feather
                    ...
                phenotypes/
                    {stage}.feather
            visor/
                genotypes.csv
                phenotypes.csv
                spectra/
                    age_at_birth.csv
                    age_at_end_of_sim.csv
                    age_at_genetic.csv
                    age_at_overshoot.csv
                    age_at_season_shift.csv
                    cumulative_ages.csv
    

    Detailed description of the content and format of output files can be found in the wiki.

Related articles

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aegis-sim-2.1.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

aegis_sim-2.1-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file aegis-sim-2.1.tar.gz.

File metadata

  • Download URL: aegis-sim-2.1.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.9

File hashes

Hashes for aegis-sim-2.1.tar.gz
Algorithm Hash digest
SHA256 5eda68735a7fbb6dee4355a48dd20d848004237412d26ae1243670796a70e995
MD5 0683b6572b5091d5c9fd0581bff1e278
BLAKE2b-256 c883d75781d086546fea35b82d9b130e0d2b221095508f7d88ca1159e6b148a4

See more details on using hashes here.

Provenance

File details

Details for the file aegis_sim-2.1-py3-none-any.whl.

File metadata

  • Download URL: aegis_sim-2.1-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.9

File hashes

Hashes for aegis_sim-2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e6292163ac8e46196ee53dfc590a5fae39b631a626bb3e8c7b24ce8555260375
MD5 77915419010ebfbc73512cb61920b3af
BLAKE2b-256 a4c6c9ea85a34340999a77ae1aee4288ec269938f4cc0a258c8a6f2897f24e8f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page