Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/llnl/radiuss
https://github.com/llnl/radiuss
llnl llnl-open-source radiuss software-portal
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/llnl/radiuss
- Owner: LLNL
- License: mit
- Created: 2021-10-20T14:57:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T04:36:59.000Z (2 months ago)
- Last Synced: 2024-10-30T06:16:20.585Z (2 months ago)
- Topics: llnl, llnl-open-source, radiuss, software-portal
- Language: CSS
- Homepage: https://software.llnl.gov/radiuss
- Size: 44.8 MB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: news/index.html
- License: LICENSE
Awesome Lists containing this project
README
# 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](.github/workflows/update-data.yaml) to get updated data
for RADIUSS projects, however you can generate the same data on your own using
[Contributor CI](https://contributor-ci.readthedocs.io/en/latest/getting_started/user-guide.html) as follows!
```bash
# 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](contributor-ci.yaml) (default) and we store data for cci in [_data](_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`
```bash
$ cci --out-dir _data extract --save-format year/month
```
And the ones we do for the site (a subset) are:
```bash
$ 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](assets/img/custom/avatars)
2. Add _just the name_ to [_data/custom.yaml](_data/custom.yaml) under avatars.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE)
file for details
All new contributions must be made under the MIT License.
See [LICENSE](https://github.com/LLNL/radiuss-ci/blob/master/LICENSE),
[COPYRIGHT](https://github.com/LLNL/radiuss-ci/blob/master/COPYRIGHT), and
[NOTICE](https://github.com/LLNL/radiuss-ci/blob/master/NOTICE) for details.
SPDX-License-Identifier: (MIT)
LLNL-CODE-793462