Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cdslaborg/paramonte-kernel-doc

Doxygen documentation of the ParaMonte kernel library

https://github.com/cdslaborg/paramonte-kernel-doc

Science Score: 13.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
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Doxygen documentation of the ParaMonte kernel library

Basic Info
  • Host: GitHub
  • Owner: cdslaborg
  • License: mit
  • Language: HTML
  • Default Branch: main
  • Size: 232 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 5 years ago · Last pushed about 2 years ago
Metadata Files
Readme License

README.md

paramonte-kernel-doc

The ParaMonte Kernel API Documentation

This project contains the Application Programming Interface documentation of the ParaMonte kernel library .
For full documentation visit the ParaMonte library's documentation website .

This repository is now archived permanently and will not be updated.
All ParaMonte library documentation source files are now located in the new paramonted repository.

Instructions to regenerate the documentation

  • Install Doxygen on your system.

  • To regenerate the ParaMonte documentation from source,

    • Create a fork of the ParaMonte project on your personal GitHub account and clone the forked ParaMonte repository on your system.
    • Create a fork of the ParaMonte kernel documentation project on your personal GitHub account and clone it inside the src folder of the ParaMonte repository.
    • When cloning is done, you should see a new subfolder /paramonte-kernel-doc in the /src folder of your local copy of ParaMonte Project.
    • Make any adjustments/updates as needed to the source of the documentation in the source files in /src/kernel subfolder.
    • Open a Bash terminal inside /src/paramonte-kernel-doc and make sure you are on the main branch of the documentation project,
    • Rebuild the new ParaMonte::Kernel documentation by calling the following script on the Bash command-line,
      bash ./build.sh
    • Inspect the message warning log of Doxygen in the output file READ_THESE_BUILD_WARNINGS.txt for any potential documentation errors.
    • Inspect the generated documentation by navigating to the /src/paramonte-kernel-doc/html folder and opening the index.html via a web browser. Make sure all new changes look fine in the browser.
    • If everything looks good, then stage, commit, and push the new documentation to your fork of the ParaMonte::Kernel documentation repository on GitHub.
      bash git add --all git commit -m"latest documentation build" git push --all
    • Open a pull request (PR) on the ParaMonte documentation repository to merge your new changes with the repository.

  • To generate new header, footer, or css stylesheet, follow the Doxygen instructions here. The regeneration command is the following:
    bash doxygen -w html new_header.html new_footer.html new_stylesheet.css config.txt

Owner

  • Name: Computational Data Science Lab
  • Login: cdslaborg
  • Kind: organization
  • Location: Texas, USA

Computational Data Science research and education, made as simple as possible, but not simpler.

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels