seismogen

A Python package for earthquake generation

https://github.com/ucl-arc/seismogen

Science Score: 52.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
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization ucl-arc has institutional domain (www.ucl.ac.uk)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary

Keywords

earthquake python
Last synced: 6 months ago · JSON representation ·

Repository

A Python package for earthquake generation

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Topics
earthquake python
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

seismogen

pre-commit Tests status Linting status Documentation status License

A Python package for earthquake generation.

This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.

About

Project team

Getting started

Pre-requisites

seismogen requires Python 3.10–3.12.

Installation

We recommend installing in a project specific virtual environment created using a environment management tool such as Conda. To install the latest development version of seismogen using pip in the currently active environment run

sh pip install git+https://github.com/UCL-ARC/seismogen.git

Alternatively create a local clone of the repository with

sh git clone https://github.com/UCL-ARC/seismogen.git

and then install in editable mode by running

sh pip install -e .

Running tests

Tests can be run across all compatible Python versions in isolated environments using tox by running

sh tox

To run tests manually in a Python environment with pytest installed run

sh pytest tests

again from the root of the repository.

Building documentation

The MkDocs HTML documentation can be built locally by running

sh tox -e docs

from the root of the repository. The built documentation will be written to site.

Alternatively to build and preview the documentation locally, in a Python environment with the optional docs dependencies installed, run

sh mkdocs serve

Owner

  • Name: UCL Advanced Research Computing Centre
  • Login: UCL-ARC
  • Kind: organization
  • Location: United Kingdom

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
authors:
  - family-names: "Gopinathan"
    given-names: "Devaraj"
    email: "d.gopinathan@ucl.ac.uk"
    orcid: "https://orcid.org/0000-0002-0490-3229"
    affiliation: "University College London"
  - family-names: "Salmanidou"
    given-names: "Dimitra"
    email: "d.salmanidou.12@ucl.ac.uk"
    affiliation: "University College London"
  - family-names: "Graham"
    given-names: "Matthew M."
    email: "m.graham@ucl.ac.uk"
    orcid: "https://orcid.org/0000-0001-9104-7960"
    affiliation: "University College London"
repository-code: "https://github.com/UCL-ARC/seismogen"
title: "seismogen: A Python package for earthquake generation"
license: "MIT"

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Devaraj-G (1)
Pull Request Authors
Top Labels
Issue Labels
question (1)
Pull Request Labels