Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

156 Commits
 
 
 
 
 
 

Repository files navigation

PHRAISE

Port-Hamiltonian Representation and Approximation of Interconnected Systems using Energy

PHRAISE gathers research material related to the port-Hamiltonian framework for modelling, discretizing and controlling physical systems.

Contributing new DOIs

We welcome contributions in the form of DOI submissions:

  • Open a pull request that adds the references to docs/newDOI.txt in the GitHub repository.
  • Alternatively, send the new DOIs by email.

Updating the website

The maintenance scripts rely on API keys for Scopus, Springer, IEEE and Mendeley. Once you have the keys available, save them in .env in the docs folder as follow:

MAIL=your-email@example.fr
SCOPUS_API_KEY=
SPRINGER_API_KEY=
IEEE_API_KEY=
MENDELEY_API_KEY=

Then, run the following workflow from the docs directory:

  1. ./looking4Update.sh – update metadata (volume, issue, etc.) and fetch the latest CrossRef entries
  2. Check entries in checkDOI.txt and decide where they belong: bad/newDOI.txt
  3. ./getData.sh newDOI.txt
  4. ./setAuthorMapping.sh – correct biblio.json entries as needed.
  5. Add new name variations or entries to assets/data/author_mappings.json – retry ./setAuthorMapping.sh to check
  6. ./concatenate.sh
  7. ./setPosts.sh && ./setPages.sh
  8. bundle exec jekyll serve --watch – verify the build locally and make final corrections.
  9. Commit and push the changes.
  10. Confirm that the site deploys correctly on GitHub Pages.

Local development

The static website that showcases the PHRAISE publications lives in the docs/ folder and is built with Jekyll. To preview the site or validate content changes locally:

  1. Install Ruby (version 3.0 or newer is recommended) and Bundler.

  2. Install the site dependencies:

    cd docs
    bundle install
  3. Serve the website with live reloading:

    bundle exec jekyll serve --watch
  4. Open http://127.0.0.1:4000 in your browser to review the generated pages.

When you are finished, stop the server with Ctrl+C. Running the site locally is especially helpful after adding new DOIs to make sure the generated posts and pages render correctly before publishing them.

About

Port-Hamiltonian Representation and Approximation of Interconnected Systems using Energy

Resources

Stars

2 stars

Watchers

1 watching

Forks

Used by

Contributors