Git Product home page Git Product logo

radiuss's Introduction

RADIUSS

Welcome to the web home of RADIUSS! Here we maintain:

  • a website with information about radiuss
  • automated pipelines to update and render plots for RADIUSS projects

The structure is under development so please come back soon!

Usage

Data

We run a nightly action to get updated data for RADIUSS projects, however you can generate the same data on your own using Contributor CI as follows!

# Export a GitHub token to the environment
export GITHUB_TOKEN=xxxxxxxxxxx

# install contributor-ci
pip install contributor-ci

# check out the extractors available!
# cci list

The tool will read in repos from contributor-ci.yaml (default) and we store data for cci in _data, so to run an extractor you can do the following. Note that we want to cache data monthly so we use --save-format year/month instead of the default of year/month/day

$ cci --out-dir _data extract --save-format year/month <extractor>

And the ones we do for the site (a subset) are:

$ cci --out-dir _data extract --save-format year/month repos repo_metadata topics languages releases stars activity_commits activity_lines

Api

The site data is served from a set of static APIs!

  • /radiuss/api/languages.json
  • /radiuss/api/releases.json
  • /radiuss/api/repos.json
  • /radiuss/api/repos-metadata.json
  • /radiuss/api/stars.json
  • /radiuss/api/topics.json
  • /radiuss/api/commits.json
  • /radiuss/api/lines.json

Custom Data

Avatars

If you want to define a custom avatar image for a project:

  1. Add the image to assets/img/custom/avatars
  2. Add just the name to _data/custom.yaml under avatars.

License

This project is licensed under the MIT License - see the LICENSE file for details

All new contributions must be made under the MIT License.

See LICENSE, COPYRIGHT, and NOTICE for details.

SPDX-License-Identifier: (MIT)

LLNL-CODE-793462

radiuss's People

Contributors

davidbeckingsale avatar hauten avatar vsoch avatar

Stargazers

avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

hauten

radiuss's Issues

LLNL/CHAI

  • branding
  • repository should describe alternatives / prior art and link to docs in top right description area
  • outreach and coverage
  • issue and PR templates
  • developer environments

Small suggestions

First, I have to say that the website looks great. Really nice job! 🎉

Here are a few small suggestions after a brief look:

Policies & Guidelines content

Current location: https://software.llnl.gov/about/policies/
Consists of: 18 markdown files (https://github.com/LLNL/llnl.github.io/tree/main/pages/project/policies)

Questions & possible tasks:

  • Move the files to this repo?
  • Or leave them where they are and link to them from this site?
  • Revisit or close outstanding issue LLNL/llnl.github.io#245, which is based on outdated functionality but the idea may be worth considering re: better navigation to/from each P&G and main landing page.
  • Update links/text within the P&G as needed (e.g., there's a link to the repo where anyone can contribute to the P&G, which would need to change if the content moves over here).
  • Remind me to update navigation on software.llnl.gov & dev.llnl.gov (internal site) if the content does move.

(No rush to decide! P&G content is welcome to remain where it is.)

hpc/Spindle

  • branding of repository
  • state similar project or prior art, and use cases in README
  • expanded set of examples or usage
  • repository doesn't have link to docs, getting started guide, contributor guide, developer guide, docs render from repo in plain text format, different versions available
  • developer environment (e.g., container setup)
  • code could be better commented
  • formatting, JoSS paper

https://github.com/vsoch/contributor-ci-llnl/blob/main/_cfa/cfa-hpc-Spindle.md

GEOSX/LvArray

  • repository would benefit from branding
  • README should state prior art and alternatives
  • README should have basic example and expanded examples in documentation
  • an automated container build would help to show dependencies and provide a quick developer environment
  • GitHub repository should have link to documentation (easy)
  • Documentation can have a getting started guide
  • issue and pr templates
  • coverage, linting, and formatting
  • presentation, or JoSS or other engagement via social media

https://github.com/vsoch/contributor-ci-llnl/blob/main/_cfa/cfa-GEOSX-LvArray.md

hypre-space/hypre

  • README should state prior art and alternatives, use cases/need and domain specific jargon should be reduced
  • example usage in the README
  • GitHub repository metadata has link to documentation, and different version are available
  • developer environments
  • docs should state how to run tests, tests should be run with CI, and tests should verify successful build and install, and coverage and formatting
  • JoSS paper or other outreach

https://github.com/vsoch/contributor-ci-llnl/blob/main/_cfa/cfa-hypre-space-hypre.md

Alpine-DAV/ascent

  • we can help to spruce up the GitHub repo with some stronger branding
  • a clear description of prior art / alternative projects is needed in the README
  • a set of clear use cases would also be great, and a quick dummy example
  • a container build can be provided to make dependencies / build explicitly clear and reproducible
  • issue templates to guide giving reports and PR templates for the same
  • code could be better commented for easier understanding
  • coverage reports and linting / formatting
  • JoSS publication or other social media connection for updates

https://github.com/vsoch/contributor-ci-llnl/blob/main/_cfa/cfa-Alpine-DAV-ascent.md

GLVis/glvis

  • repo should describe prior art, alternatives, and not use domain-specific jargon so heavily
  • documentation should have a getting started guide, renders from plain text format, state how to run tests, served in version control alongside the code, and different versions should be available.
  • issue templates and linting/formatting
  • container environment provided to show building and provide quick testing or developer environment
  • coverage
  • outreach or JoSS article

https://github.com/vsoch/contributor-ci-llnl/blob/main/_cfa/cfa-GLVis-glvis.md

RAJA & hypre avatars

https://software.llnl.gov/radiuss/projects/

  1. RAJA avatar exists in the right place with the right name (https://github.com/LLNL/radiuss/blob/main/assets/img/custom/avatars/llnl-raja.png), but the generic LLNL open source logo appears instead.
  2. hypre avatar is too large and only shows the "H" (although it does look cool and is perhaps intended). I wasn't sure where the image file resides, unless it's pulled in from the repo directly. A smaller sized file is here, if you want it: https://github.com/LLNL/llnl.github.io/blob/main/assets/images/logos/hypre-space/hypre.png

Reconcile which repos belong here

Comparing sources of truth:

  • software.llnl.gov/explore/#/RADIUSS – has two Hatchets (LLNL org, hatchet org); has radiuss-ci, radiuss, radiuss-spack-testing (I understand why these would not be in this new repo)
  • this repo – missing: spot2_container, spotfe, spotbe, b-mpi3
  • LC Confluence RADIUSS home – lists all spot repos, b-mpi3, & hatchet/hatchet

Questions for this repo specifically:

  • Should these be added: spot2_container, spotfe, spotbe, b-mpi3
  • Should LLNL/hatchet change to hatchet/hatchet

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.