TREvoSim v3

TREvoSim v3: An individual based simulation for generating trees and character data - Published in JOSS (2024)

https://github.com/palaeoware/trevosim

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 25 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    2 of 3 committers (66.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Engineering Computer Science - 37% confidence
Last synced: 4 months ago · JSON representation ·

Repository

TREvoSim - The [Tr]ee [Evo]lutionary [Sim]ulator program

Basic Info
  • Host: GitHub
  • Owner: palaeoware
  • License: gpl-3.0
  • Language: C++
  • Default Branch: master
  • Size: 30.2 MB
Statistics
  • Stars: 6
  • Watchers: 2
  • Forks: 3
  • Open Issues: 11
  • Releases: 4
Created over 7 years ago · Last pushed 5 months ago
Metadata Files
Readme License Citation Codemeta

README.md

TREvoSim

[Tr]ee [Evo]lutionary [Sim]ulator Program

DOI DOI DOCS

TREvoSim is an individual-based evolutionary simulation. It creates evolutionary trees and associated character data using a model that with a fitness algorithm and replication that incorporates mutation.

Code by: - Russell J. Garwood (russell.garwood@gmail.com).

GUI theme and test automation by: - Alan R.T. Spencer (alan.spencer@imperial.ac.uk).


Relevant references:

Garwood, R.J., Spencer A.R.T. and Sutton, M.D., 2019. REvoSim: Organism-level simulation of macro- and microevolution. Palaeontology 62(3),339-355. DOI: 10.1111/pala.12420 (describes fitness algorithm)

Keating, J.N., Sansom, R.S., Sutton, M.D., Knight, C.G., and Garwood, R.J. 2020. Morphological phylogenetics evaluated using novel evolutionary simulations. Systematic Biology 69(5):897-912. DOI: 10.1093/sysbio/syaa012 (describes, and utilises, TREvoSim v1.0.0)

Mongiardino Koch, N., Garwood, R.J. and Parry, L.A. 2021. Fossils improve phylogenetic analyses of morphological characters. Proceedings of the Royal Society B: 288(1950):20210044. DOI: 10.1098/rspb.2021.0044 (describes, and utilises, TREvoSim v2.0.0)

Mongiardino Koch, N., Garwood, R.J. and Parry, L.A. 2023. Inaccurate fossil placement does not compromise tip‐dated divergence times. Palaeontology, 66(6): e12680. DOI: 10.1111/pala.12680 (utilises TREvoSim v2.0.0)

Garwood, R.J., Spencer, A.R.T., Callender-Crowe, L.M., Dunn, F.S., Halliday, T.J., Keating, J.N., Koch, N.M., Parry, L.A., Sansom, R.S., Smith, T.J. and Sutton, M.D. 2024. TREvoSim v3: An individual based simulation for generating trees and character data. Journal of Open Source Software, 9(101):6722. DOI: 10.21105/joss.06722 (describes TREvoSim v3.0.0)

Smith, T.J., Parry, L.A., Dunn, F.S. and Garwood, R.J. 2024. Exploring the macroevolutionary impact of ecosystem engineers using an individual‐based eco‐evolutionary simulation. Palaeontology, 67(5): e12701. DOI: 10.1111/pala.12701 (utilises TREvoSim v3.0.0)


Contents:

  1. Copyright and Licence
  2. Installation
  3. Usage
  4. Contributing to the code
  5. Bug reporting and feature requests

1. Copyright and Licence

All TREvoSim code is released under the GNU General Public License. See LICENSE.md files in the programme directory.

All TREvoSim code is copyright 2024 by Russell J. Garwood and Alan R.T. Spencer. Please see the Repository Contribution document for further information on copyright.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but without any warranty.


2. Installation

TREvoSim can be installed and installed/run from the binary releases on our GitHub: see the page releases for the latest release. Installation instructions can be found in the documentation (linked below).

If you wish to modify the software, and thus compile TREvoSim on your system this requires the Qt library. The software has been tested with Qt versions 5.6-5.15 (v1,2), and 6.2-6.5 (v3). Versions 1 and 2 should be compatible with all Qt 5 versions greater than 5.3, v3 will compile with Qt versions >6.0. TREvoSim has been tested on Windows, Mac OS and Ubuntu Linux, but will in theory work on any Qt-capable system. Build guides are provided in the documentation.


3. Documentation

Full descriptions of the algorithms used in this package, and all simulation variables, as well as guidance on experimental design and data analysis are included in the documentation on readthedocs.


4. Contributing to the code

Contribution to the code in this repository is welcome. Please read the Repository Contribution document for information on our licencing, code of conduct, coding style, and repository structure before submitting any code updates.

We are grateful to the following for contributing code to TREvoSim:

  • Martin R Smith (@ms609)

5. Bug reporting and feature requests

Bug reporting and feature requests should be made through the GitHub Issues page for this repository. We will aim to respond to all issues and feature requests in a timely manner.

e:palaeoware@gmail.com

w:https://github.com/palaeoware

Owner

  • Name: palaeoware
  • Login: palaeoware
  • Kind: organization
  • Email: palaeoware@gmail.com

Palaeontology Software for People Stuck in the Past

JOSS Publication

TREvoSim v3: An individual based simulation for generating trees and character data
Published
September 12, 2024
Volume 9, Issue 101, Page 6722
Authors
Russell J. Garwood ORCID
Department of Earth and Environmental Sciences, University of Manchester, Manchester, M13 9PL, United Kingdom, Natural History Museum, London, SW7 5BD, United Kingdom
Alan R. t. Spencer ORCID
Natural History Museum, London, SW7 5BD, United Kingdom, Department of Earth Science and Engineering, Imperial College, London, SW7 2AZ, United Kingdom
Charles T. m. Bates ORCID
Department of Earth and Environmental Sciences, University of Manchester, Manchester, M13 9PL, United Kingdom
Leah M. Callender-Crowe ORCID
School of Biological Sciences, University of Reading, Reading, United Kingdom
Frances S. Dunn ORCID
Oxford University Museum of Natural History, University of Oxford, Oxford, OX1 3PW, United Kingdom
Thomas J.d. Halliday ORCID
School of Geography, Earth and Environmental Sciences, University of Birmingham, Birmingham B15 2TT, United Kingdom
Joseph N. Keating ORCID
School of Earth Sciences, University of Bristol, Life Sciences Building, Tyndall Avenue, Bristol, BS8 1TQ, United Kingdom
Nicolás Mongiardino Koch ORCID
Scripps Institution of Oceanography, UC San Diego, La Jolla, CA 92122, United States of America
Luke A. Parry ORCID
Department of Earth Sciences, University of Oxford, Oxford, OX1 3AN, United Kingdom
Robert S. Sansom ORCID
Department of Earth and Environmental Sciences, University of Manchester, Manchester, M13 9PL, United Kingdom
Thomas J. Smith ORCID
Department of Earth Sciences, University of Oxford, Oxford, OX1 3AN, United Kingdom
Mark D. Sutton ORCID
Department of Earth Science and Engineering, Imperial College, London, SW7 2AZ, United Kingdom
Thomas Vanteghem ORCID
Erasmus Mundus Joint Master Degree PANGEA, Université de Lille, France
Editor
Frederick Boehm ORCID
Tags
evolution simulation phylogenetics ecology palaeontology

Citation (citation.cff)

cff-version: "1.2.0"
authors:
- family-names: Garwood
  given-names: Russell J.
  orcid: "https://orcid.org/0000-0002-2803-9471"
- family-names: Spencer
  given-names: Alan R. T.
  orcid: "https://orcid.org/0000-0001-6590-405X"
- family-names: Bates
  given-names: Charles T. M.
  orcid: "https://orcid.org/0009-0000-8444-6322"
- family-names: Callender-Crowe
  given-names: Leah M.
  orcid: "https://orcid.org/0000-0002-5870-1964"
- family-names: Dunn
  given-names: Frances S.
  orcid: "https://orcid.org/0000-0001-7080-5283"
- family-names: Halliday
  given-names: Thomas J. D.
  orcid: "https://orcid.org/0000-0002-4077-732X"
- family-names: Keating
  given-names: Joseph N.
  orcid: "https://orcid.org/0000-0002-2667-7795"
- family-names: Mongiardino Koch
  given-names: Nicolás
  orcid: "https://orcid.org/0000-0001-6317-5869"
- family-names: Parry
  given-names: Luke A.
  orcid: "https://orcid.org/0000-0002-3910-0346"
- family-names: Sansom
  given-names: Robert S.
  orcid: "https://orcid.org/0000-0003-1926-2556"
- family-names: Smith
  given-names: Thomas J.
  orcid: "https://orcid.org/0000-0002-2083-7452"
- family-names: Sutton
  given-names: Mark D.
  orcid: "https://orcid.org/0000-0002-7137-7572"
- family-names: Vanteghem
  given-names: Thomas
  orcid: "https://orcid.org/0009-0003-3513-8448"
contact:
- family-names: Garwood
  given-names: Russell J.
  orcid: "https://orcid.org/0000-0002-2803-9471"
doi: 10.5281/zenodo.13358420
title: "TREvoSim"
version: 3.0.0
date-released: 2024-08-22
url: "https://github.com/palaeoware/trevosim/"
message: If you use v3 of TREvoSim, please cite cite our article in the Journal of Open Source Software. See references for other relevant papers associated with previous versions of the software and related packages.
preferred-citation:
  authors:
  - family-names: Garwood
    given-names: Russell J.
    orcid: "https://orcid.org/0000-0002-2803-9471"
  - family-names: Spencer
    given-names: Alan R. T.
    orcid: "https://orcid.org/0000-0001-6590-405X"
  - family-names: Bates
    given-names: Charles T. M.
    orcid: "https://orcid.org/0009-0000-8444-6322"
  - family-names: Callender-Crowe
    given-names: Leah M.
    orcid: "https://orcid.org/0000-0002-5870-1964"
  - family-names: Dunn
    given-names: Frances S.
    orcid: "https://orcid.org/0000-0001-7080-5283"
  - family-names: Halliday
    given-names: Thomas J. D.
    orcid: "https://orcid.org/0000-0002-4077-732X"
  - family-names: Keating
    given-names: Joseph N.
    orcid: "https://orcid.org/0000-0002-2667-7795"
  - family-names: Mongiardino Koch
    given-names: Nicolás
    orcid: "https://orcid.org/0000-0001-6317-5869"
  - family-names: Parry
    given-names: Luke A.
    orcid: "https://orcid.org/0000-0002-3910-0346"
  - family-names: Sansom
    given-names: Robert S.
    orcid: "https://orcid.org/0000-0003-1926-2556"
  - family-names: Smith
    given-names: Thomas J.
    orcid: "https://orcid.org/0000-0002-2083-7452"
  - family-names: Sutton
    given-names: Mark D.
    orcid: "https://orcid.org/0000-0002-7137-7572"
  - family-names: Vanteghem
    given-names: Thomas
    orcid: "https://orcid.org/0009-0003-3513-8448"
  date-published: 2024-09-12
  doi: 10.21105/joss.06722
  issn: 2475-9066
  issue: 101
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6722
  title: "TREvoSim v3: An individual based simulation for generating
    trees and character data"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06722"
  volume: 9
title: "TREvoSim v3: An individual based simulation for generating trees
  and character data"

CodeMeta (codemeta.json)

{
  "@context": "https://w3id.org/codemeta/3.0",
  "type": "SoftwareSourceCode",
  "applicationCategory": "Evolutionary simulation",
  "author": [
    {
      "id": "https://orcid.org/0000-0002-2803-9471",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Department of Earth and Environmental Sciences, University of Manchester, Manchester, M13 9PL, United Kingdom; Natural History Museum, London, SW7 5BD, United Kingdom"
      },
      "email": "russell.garwood@gmail.com",
      "familyName": "Garwood",
      "givenName": "Russell J."
    },
    {
      "type": "Role",
      "schema:author": "https://orcid.org/0000-0002-2803-9471",
      "roleName": "Developer",
      "startDate": "2017-01-01"
    },
    {
      "id": "https://orcid.org/0000-0001-6590-405X",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Department of Earth Science and Engineering, Imperial College, London, SW7 2AZ, United Kingdom; Natural History Museum, London, SW7 5BD, United Kingdom"
      },
      "familyName": "Spencer",
      "givenName": "Alan R.T. "
    },
    {
      "type": "Role",
      "schema:author": "https://orcid.org/0000-0001-6590-405X",
      "roleName": "Developer",
      "startDate": "2019-07-01"
    }
  ],
  "codeRepository": "git+https://github.com/palaeoware/trevosim",
  "dateModified": "2024-08-22",
  "datePublished": "2021-01-21",
  "description": "TREvoSim is an individual-based evolutionary simulation. It creates evolutionary trees and associated character data using a model that with a fitness algorithm and replication that incorporates mutation.",
  "downloadUrl": "https://github.com/palaeoware/trevosim/releases/tag/v3.0.0",
  "identifier": "10.5281/zenodo.13358420",
  "keywords": [
    "Phylogenetics",
    "evolution",
    "modelling"
  ],
  "license": "https://spdx.org/licenses/GPL-3.0",
  "name": "TREvoSim",
  "operatingSystem": [
    "Windows",
    "MacOS",
    "Linux"
  ],
  "programmingLanguage": "C++",
  "releaseNotes": "The changes in v3.0.0 are described and discussed fully in the associated paper. In brief, these include:\n\n-- New character options\n-- New default simulation parameters\n-- Ecosystem engineering functionality\n-- An expanding playing field mode\n-- New logging capabilities\n-- The option to match fitness peaks across environments\n-- A no selection mode\n-- Mixing of organisms between playing fields\n-- Perturbations (periods of accelerated environmental change)\n-- The ability to run the simulation for a user-defined number of iterations, as opposed to for set number of species\n-- Abstraction of the fitness algorithm from the genome via many-to-one mapping (stochastic layer)\n-- A test suite integrated into the software build",
  "review": {
    "type": "Review",
    "reviewAspect": "TREvoSim v3: An individual based simulation for generating trees and character data",
    "reviewBody": "Paper accompanying release of v3.0.0"
  },
  "version": "3.0.0",
  "developmentStatus": "active",
  "funding": " BBSRC - BB/N015827/1, NERC - NE/T000813/1, Leverhulme Trust -  RPG-2023-234, the Alexander von Humboldt Foundation",
  "issueTracker": "https://github.com/palaeoware/trevosim/issues",
  "referencePublication": "https://doi.org/10.21105/joss.06722"
}

GitHub Events

Total
  • Issues event: 5
  • Watch event: 1
  • Delete event: 5
  • Issue comment event: 17
  • Push event: 58
  • Pull request event: 7
  • Create event: 7
Last Year
  • Issues event: 5
  • Watch event: 1
  • Delete event: 5
  • Issue comment event: 17
  • Push event: 58
  • Pull request event: 7
  • Create event: 7

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 410
  • Total Committers: 3
  • Avg Commits per committer: 136.667
  • Development Distribution Score (DDS): 0.1
Past Year
  • Commits: 158
  • Committers: 3
  • Avg Commits per committer: 52.667
  • Development Distribution Score (DDS): 0.057
Top Committers
Name Email Commits
RussellGarwood r****d@m****k 369
Alan R.T. Spencer a****r@i****k 29
Martin R. Smith 1****9 12
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 55
  • Total pull requests: 17
  • Average time to close issues: 26 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 4
  • Total pull request authors: 2
  • Average comments per issue: 2.6
  • Average comments per pull request: 0.65
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 7
  • Average time to close issues: 4 days
  • Average time to close pull requests: about 20 hours
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 1.25
  • Average comments per pull request: 0.0
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ms609 (49)
  • RussellGarwood (6)
  • atcribb (2)
  • alanspencer (1)
Pull Request Authors
  • ms609 (21)
  • RussellGarwood (7)
Top Labels
Issue Labels
enhancement (4) documentation (3) bug (2)
Pull Request Labels

Dependencies

docs_build/_sources/requirementsinstallation.rst.txt pypi
  • 1.Aportablebinaryreleasewithina.ZIParchive.Torunthis ,allyouneedtodoisextracttheziptoaconvenientlocation,anddoubleclickonthe.exefile.
  • 2.Aselfcontainedinstaller-downloadanddoubleclickonthefile ,whichwillguideyouthoughtheinstallationprocess.
  • Binarydownloadlocations *
  • ForLinuxusers ,pleaseseethe
  • ForTREvoSimv1.Xandv2.Xweprovidea.ZIParchivecontainingtheTREvoSimprogramthatcanbedownloadedfromtheTREvoSimGitHubrepository. *
  • ForTREvoSimv3.Xweprovidea.DMGimagetoinstallthesoftware.Downloadanddoubleclickonthe.dmgandfollowtheonscreeninstructions.Youmayberequiredtotheapprovethesoftwareinsecurityandprivacysettingsbeforeitwilllaunch. *
  • ForWindowsusersweprovidetwomeansofinstallation *
  • InstallationfromBinaries *
  • MacOS *
  • Note *
  • Requirements *
  • RequirementsandInstallationfromBinaries *
  • TREvoSimhasnominimumrequirementsassuch ,andwillrunonmoststandardsystems
  • Ubuntu64-bit *
  • Windows64-bit *
  • Youcandownloadpre-compiledbinaryreleasesandpackagedinstallersfromtheTREvoSimGitHubrepository *
requirements.txt pypi
  • readthedocs-sphinx-search ==0.3.2
  • sphinx ==5.3.0
  • sphinx-multiproject *
  • sphinx_rtd_theme ==1.1.1