Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add page with cards for developmental packages #31

Merged
merged 5 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Reciprocal Space Station
plugins:
- jekyll-font-awesome-sass

port: 4502
port: 4503
2 changes: 2 additions & 0 deletions _data/navbar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@
link: /publications.html
- name: Installation
link: /installation.html
- name: In Development
link: /development.html
- name: Blog
link: /blog.html
14 changes: 10 additions & 4 deletions _data/packages.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
- name: reciprocalspaceship
type: production
link: https://github.com/rs-station/reciprocalspaceship
docs: https://rs-station.github.io/reciprocalspaceship/
desc: Tools for exploring reciprocal space. This package provides a crystallographically-aware extension of `pandas` and other useful reciprocal-space tools
- name: careless
type: production
link: https://github.com/rs-station/careless
desc: Applying variational inference to the scaling and merging of crystallographic data
examples: https://github.com/rs-station/careless-examples
- name: matchmaps
type: production
link: https://github.com/rs-station/matchmaps
docs: https://rs-station.github.io/matchmaps/
desc: Make difference maps between near-isomorphous or non-isomorphous datasets
- name: laue-dials
type: production
link: https://github.com/rs-station/laue-dials
docs: https://rs-station.github.io/laue-dials/
desc: Extending `DIALS` for polychromatic "pink beam" data collected at Laue X-ray sources
#- name: abismal
# link: https://github.com/rs-station/abismal
# desc: "**A**pproximate **B**ayesian **I**nference for **S**caling and **M**erging at **A**dvanced **L**ightsources"
- name: rs-booster
type: production
link: https://github.com/rs-station/rs-booster
docs: https://rs-station.github.io/rs-booster/
desc: A "booster rocket" for `reciprocalspaceship` containing useful command-line utilities
desc: A "booster rocket" for `reciprocalspaceship` containing useful command-line utilities
- name: abismal
type: development
link: https://github.com/rs-station/abismal
desc: "**A**pproximate **B**ayesian **I**nference for **S**caling and **M**erging at **A**dvanced **L**ightsources"
51 changes: 34 additions & 17 deletions _includes/cards.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,50 @@ <h2 class="card-title">Blog</h2>
</div>

{% for card in site.data.packages %}
{% if card.type == 'production' %}
<div class="col-md-4 mb-5">
<div class="card h-100">
<div class="card-body">
<h2 class="card-title">{{ card.name }}</h2>
<p class="card-text">{{ card.desc | markdownify }}</p>
</div>
<div class="card-footer">
{% if card.docs %}
<a class="btn btn-secondary btn-sm" href="{{ card.docs }}" >
View Documentation
</a>
{% endif %}

{% if card.examples %}
<a class="btn btn-secondary btn-sm" href="{{ card.examples }}" >
Examples
</a>
{% endif %}
<a class="btn btn-primary btn-sm" href="{{ card.link }}" >
View on GitHub
</a>

</div>
</div>
</div>

{% endif %}
{% endfor %}

<div class="col-md-4 mb-5">
<div class="card h-100">
<div class="card-body">
<h2 class="card-title">{{ card.name }}</h2>
<p class="card-text">{{ card.desc | markdownify }}</p>
<h2 class="card-title">Development zone</h2>
<p class="card-text">More RSS packages, still under active development; use at your own risk!</p>
</div>
<div class="card-footer">
{% if card.docs %}
<a class="btn btn-secondary btn-sm" href="{{ card.docs }}" >
View Documentation
</a>
{% endif %}
<div class="blog-footer">

{% if card.examples %}
<a class="btn btn-secondary btn-sm" href="{{ card.examples }}" >
Examples
</a>
{% endif %}
<a class="btn btn-primary btn-sm" href="{{ card.link }}" >
View on GitHub
<a class="btn btn-primary btn-sm" href="/development.html" >
See packages
</a>

</div>
</div>
</div>

{% endfor %}

</div>
33 changes: 33 additions & 0 deletions _includes/development_cards.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<div class="row gx-4 gx-lg-5">

{% for card in site.data.packages %}
{% if card.type == 'development' %}
<div class="col-md-6 mb-5">
<div class="card h-100">
<div class="card-body">
<h2 class="card-title">{{ card.name }}</h2>
<p class="card-text">{{ card.desc | markdownify }}</p>
</div>
<div class="card-footer">
{% if card.docs %}
<a class="btn btn-secondary btn-sm" href="{{ card.docs }}" >
View Documentation
</a>
{% endif %}

{% if card.examples %}
<a class="btn btn-secondary btn-sm" href="{{ card.examples }}" >
Examples
</a>
{% endif %}
<a class="btn btn-primary btn-sm" href="{{ card.link }}" >
View on GitHub
</a>

</div>
</div>
</div>

{% endif %}
{% endfor %}
</div>
13 changes: 13 additions & 0 deletions development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: In Development
layout: content_page
---

# Packages under development

The following packages are a part of the Reciprocal Space Station organization, but are still under active development. The functionality and/or API for these packages may change in the future; they may not be fully documented. That said, if you're interested in using one of these packages, you still can! If you run into any issues, don't hesitate to reach out by filing an issue on GitHub.

{% include development_cards.html %}

<p><a href="/">⬅️ Back to production-ready packages</a></p>

Loading