Data

Tools

Indexes

Applications

Experiments

Open Source Science

pysatecosystem_template

Template area for standard pysat ecosystem repository files

https://github.com/pysat/pysatecosystem_template

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
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.9%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Template area for standard pysat ecosystem repository files

Basic Info
  • Host: GitHub
  • Owner: pysat
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Size: 2.11 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 3
  • Releases: 2
Created over 3 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Zenodo

README.md

PACKAGENAME

PACKAGENAME: pysat support for THIS TYPE OF DATA OR ANALYSIS

Pytest with Flake8 Coverage Status DOI Documentation [PyPI] version (ADD PYPI LINK)

This package DOES THIS THING.

Installation

The following instructions provide a guide for installing PACKAGENAME and give some examples on how to use the routines.

Prerequisites

PACKAGENAME uses common Python modules, as well as modules developed by and for the Space Physics community. This module officially supports Python 3.X+.

| Common modules | Community modules | | -------------- | ----------------- | | numpy | pysat >= 3.0.4 | | pandas | | | xarray | |

PyPi Installation

pip install PACKAGENAME

GitHub Installation

git clone https://github.com/pysat/PACKAGENAME.git

Change directories into the repository folder and run the pyproject.toml or setup.py file. For a local install use the "--user" flag after "install".

cd PACKAGENAME/ python -m build . pip install .

Note: pre-0.1.0 version

Only include this if PACKAGENAME is currently in an alpha development phase. Feedback and contributions are appreciated.

Examples

The instrument modules are portable and designed to be run like any pysat instrument.

import pysat import PACKAGENAME inst = pysat.Instrument(inst_module=PACKAGENAME.instruments.EX_INST)

Another way to use the instruments in an external repository is to register the instruments. This only needs to be done the first time you load an instrument. Afterward, pysat will identify them using the platform and name keywords.

pysat.utils.registry.register('PACKAGENAME.instruments.EX_INST') inst = pysat.Instrument('EX', 'INST')

The package also includes analysis tools. Detailed examples are in the documentation.

Owner

  • Name: pysat
  • Login: pysat
  • Kind: organization
  • Email: pysatDevelopers@gmail.com

GitHub Events

Total
Last Year

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 72
  • Total Committers: 3
  • Avg Commits per committer: 24.0
  • Development Distribution Score (DDS): 0.306
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Angeline G. Burrell a****l@n****l 50
jklenzing j****g 21
Russell Stoneback g****b@c****o 1
Committer Domains (Top 20 + Academic)
cosmicstudio.io: 1 nrl.navy.mil: 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 13
  • Total pull requests: 35
  • Average time to close issues: 11 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 1.15
  • Average comments per pull request: 0.17
  • Merged pull requests: 35
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 10
  • Average time to close issues: N/A
  • Average time to close pull requests: about 12 hours
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • jklenzing (7)
  • aburrell (1)
  • rstoneback (1)
Pull Request Authors
  • aburrell (14)
  • jklenzing (8)
  • rstoneback (2)
Top Labels
Issue Labels
enhancement (3)
Pull Request Labels
documentation (2) enhancement (2)

Dependencies

.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/pysat_rc.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
requirements.txt pypi
  • numpy *
  • packaging *
  • pandas *
  • pysat >=3.0.4
  • xarray *
test_requirements.txt pypi
  • coveralls * test
  • flake8 * test
  • flake8-docstrings * test
  • hacking >=1.0 test
  • m2r2 * test
  • numpydoc * test
  • pytest-cov * test
  • pytest-ordering * test
  • sphinx * test
  • sphinx_rtd_theme * test
.github/workflows/pip_rc_install.yml actions
pyproject.toml pypi
  • numpy *
  • packaging *
  • pandas *
  • pysat >=3.1.0
  • xarray *