Science Score: 36.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
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.2%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: NCAR
  • Language: HTML
  • Default Branch: main
  • Size: 81.4 MB
Statistics
  • Stars: 0
  • Watchers: 5
  • Forks: 1
  • Open Issues: 3
  • Releases: 0
Created over 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License Citation

README.md

VaporDocumentationWebsite

This repository holds the html files that are used to host Vapor's documentation github page.

We use the Sphinx documentation generator to produce the html for the website.

To reproduce this documentation locally, we recommend setting up a conda environment with the environment.yml file included in this repo. Once installed, the .rst files located in the docs/ directory can be edited to produce new html.

$ git clone https://github.com/NCAR/VaporDocumentationWebsite.git
$ cd VaporDocumentationWebsite
$ conda config --add channels conda-forge
$ conda env create -f environment.yml
$ conda activate VaporDocumentationWebsite
$ pip install sphinxcontrib-googleanalytics
$ pip install sphinx-copybutton

Once this conda environment has been configured, the html can be generated with the following steps.

1) cd VaporDocumentationWebsite/docs 2) make html 3) cp -r html/* ../

Note that step 3 moves the html files from VaporDocumentationWebsite/docs/html to the root directory, VaporDocumentationWebsite. Without this step, github pages will not host the the html files.

Owner

  • Name: NSF National Center for Atmospheric Research
  • Login: NCAR
  • Kind: organization
  • Location: Boulder, CO

NSF NCAR is sponsored by the U.S. National Science Foundation and managed by the University Corporation for Atmospheric Research.

GitHub Events

Total
  • Issues event: 4
  • Delete event: 3
  • Issue comment event: 9
  • Push event: 160
  • Pull request event: 39
  • Create event: 16
Last Year
  • Issues event: 4
  • Delete event: 3
  • Issue comment event: 9
  • Push event: 160
  • Pull request event: 39
  • Create event: 16

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 310
  • Total Committers: 2
  • Avg Commits per committer: 155.0
  • Development Distribution Score (DDS): 0.316
Past Year
  • Commits: 268
  • Committers: 2
  • Avg Commits per committer: 134.0
  • Development Distribution Score (DDS): 0.362
Top Committers
Name Email Commits
sgpearse p****e@u****u 212
Ian Franda i****a@g****m 98
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 9
  • Total pull requests: 62
  • Average time to close issues: 25 days
  • Average time to close pull requests: 2 days
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 1.22
  • Average comments per pull request: 0.18
  • Merged pull requests: 49
  • Bot issues: 0
  • Bot pull requests: 31
Past Year
  • Issues: 4
  • Pull requests: 42
  • Average time to close issues: 28 days
  • Average time to close pull requests: 1 day
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 1.75
  • Average comments per pull request: 0.12
  • Merged pull requests: 34
  • Bot issues: 0
  • Bot pull requests: 23
Top Authors
Issue Authors
  • ifranda (4)
  • sgpearse (4)
  • NihanthCW (1)
Pull Request Authors
  • github-actions[bot] (40)
  • sgpearse (23)
  • ifranda (17)
  • NihanthCW (1)
Top Labels
Issue Labels
documentation (1) enhancement (1)
Pull Request Labels

Dependencies

docs/environment.yaml conda
  • python 3.9.*
  • sphinx 4.2.0.*
  • sphinx-book-theme >=0.0.38
  • sphinx-gallery
  • vapor