Data

Tools

Indexes

Applications

Experiments

Open Source Science

ngehtsim

A repository of simulation material for the ngEHT collaboration

https://github.com/smithsonian/ngehtsim

Science Score: 26.0%

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

  • ○
    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
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

A repository of simulation material for the ngEHT collaboration

Basic Info
  • Host: GitHub
  • Owner: Smithsonian
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 1.59 GB
Statistics
  • Stars: 5
  • Watchers: 18
  • Forks: 4
  • Open Issues: 7
  • Releases: 6
Created about 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

ngehtsim

Documentation Build status Python versions Code coverage

A set of tools for generating synthetic data for the Event Horizon Telescope (EHT), the next-generation Event Horizon Telescope (ngEHT), and other very long baseline interferometric arrays of radio telescopes.

Getting started

Details about installing and using ngehtsim can be found in the online documentation.

Note that ngehtsim currently only runs on Unix-based systems (e.g., macOS, Linux) due to dependency restrictions. Windows installations are thus not currently supported.

Setting up the environment

ngehtsim is only tested on Python 3.8 and higher, and it may break for earlier versions. It is recommended that you install ngehtsim using a virtual environment, e.g.:

$ git clone https://github.com/Smithsonian/ngehtsim $ python -m venv .venv $ source .venv/bin/activate (.venv) $ python -m pip install --upgrade pip (.venv) $ pip install ./ngehtsim

There is an optional calibration functionality that requires some additional dependencies; it can be installed using:

(.venv) $ pip install ./ngehtsim[calib]

Checking that it works

There are a number of example scripts contained in the examples folder. You can check to make sure your ngehtsim installation is working by running one of these scripts, e.g.:

(.venv) $ cd ./ngehtsim/examples/example_data_generation (.venv) $ python ./generate_observation.py

Versioning scheme

For this repository, we attempt to adhere to the major.minor.patch Semantic Versioning numbering scheme.

Licensing

See the LICENSE file for details on the licensing of this software.

Owner

  • Name: Smithsonian Institution
  • Login: Smithsonian
  • Kind: organization
  • Email: davisda@si.edu
  • Location: Washington, DC

Smithsonian Institution OCIO Central GitHub

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 13
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 30
  • Pull request event: 2
  • Fork event: 1
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 13
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 30
  • Pull request event: 2
  • Fork event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 24
  • Total pull requests: 15
  • Average time to close issues: 5 months
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 2
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 8 hours
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 0.2
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • dpesce (16)
  • danielpalumbo (4)
  • ptiede (2)
  • kazuakiyama (1)
Pull Request Authors
  • dpesce (18)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/run_unit_tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/run_code_coverage.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v3 composite
  • schneegans/dynamic-badges-action v1.6.0 composite