A Python code for population synthesis of protoplanetary discs

Diskpop is a Python code used to generate and evolve synthetic populations of protoplanetary discs. It includes the viscous, hybrid and MHD-wind driven accretion prescriptions, internal and external photoevaporation, as well as dust evolution.

The physical processes and solution algorithms employed are described in Solution algorithms, while the initial conditions are discussed in Initial conditions.

To analyse the raw output of Diskpop, the Python library popcorn is available. Both codes have been published in Somigliana et al. (2024).

Using Diskpop for your work

Diskpop and popcorn are freely available for the community to use. If you use Diskpop simulations in your work, please make sure to cite Somigliana et al. (2024). The code is based on Richard Booth’s repository, and the dust module is entirely forked with no modifications; if you include dust in your simulations, please cite also Booth et al. (2017).

Installation

Diskpop can be installed from terminal as

pip install diskpop

Alternatively, it is also possible to clone the Bitbucket repository.

Likewise, the output analysis library popcorn can be installed from terminal as

pip install popcorn_diskpop

or accessed cloning the Bitbucket repository.

Diskpop Team

Diskpop and popcorn have been developed by Alice Somigliana, Giovanni Rosotti, Marco Tazzari, Leonardo Testi, Giuseppe Lodato, Claudia Toci, Rossella Anania, and Benoît Tabone. Both codes are under active development; for questions or bugs report, see Bugs and features.

Documentation contents:

• 1. Basic Functioning
  • 1.1. Disc evolution
  • 1.2. Disc dispersal
• 2. User interface
  • 2.1. Initial parameters
    • 2.1.1. parameters_options
    • 2.1.2. parameters_population
    • 2.1.3. parameters_singledisc
  • 2.2. Running Diskpop
  • 2.3. Output
• 3. Solution algorithm
  • 3.1. Generation of the initial population
  • 3.2. Evolution algorithm
    • 3.2.1. Analytical solutions
    • 3.2.2. Numerical integration
  • 3.3. Disc dispersal
• 4. popcorn
  • 4.1. Installation
  • 4.2. popcorn functions
    • 4.2.1. Used in the tutorial notebook
    • 4.2.2. Additional functions
  • 4.3. Tutorial
• 5. Bugs and features
  • 5.1. Reported issues
  • 5.2. Reporting bugs and requesting features
    • 5.2.1. Bug reports
    • 5.2.2. Requesting new features
    • 5.2.3. Active developers

Acknowledgements

This project was partly supported by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) - Ref no. 325594231 FOR 2634/2 TE 1024/2-1, by the DFG Cluster of Excellence Origins (www.origins-cluster.de). This projec has received funding from the European Research Council (ERC) via the ERC Synergy Grant ECOGAL (grant 855130).