Skip to content

Commit 788cf2a

Browse files
vsochvsoch
committed
first draft of river visualization site!
This first draft should include basic branding to match the current riverml.xyz site and a simple example with river and plotting centroids. I will need to turn on gh-pages for the automated docs workflow to work, and I will also be adding circle-ci soon to have previews on pull requests. Signed-off-by: vsoch <[email protected]>
0 parents  commit 788cf2a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1600
-0
lines changed

‎.all-contributorsrc

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"projectName": "viz",
3+
"projectOwner": "online-ml",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 100,
10+
"commit": true,
11+
"commitConvention": "none",
12+
"contributors": [],
13+
"contributorsPerLine": 7
14+
}

‎.github/CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team leaders @MaxHalford or @vsoch. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org

‎.github/workflows/docs.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Update Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
jobs:
8+
generate-docs:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
with:
13+
ref: "gh-pages"
14+
15+
- name: Create conda environment
16+
run: conda create --quiet -c conda-forge --name viz
17+
18+
- name: Install River and Dependencies
19+
run: |
20+
export PATH="/usr/share/miniconda/bin:$PATH"
21+
root=$PWD
22+
source activate viz
23+
cd /tmp
24+
git clone https://github.com/online-ml/viz
25+
cd viz
26+
conda install pandoc
27+
pip install -e .
28+
pip install -r requirements.txt
29+
make html
30+
mv $root/.git _build/html/.git
31+
rm -rf $root
32+
mv _build/html $root
33+
cd $root
34+
touch .nojekyll
35+
ls
36+
37+
- name: Deploy 🚀
38+
uses: JamesIves/[email protected]
39+
with:
40+
branch: gh-pages
41+
folder: .

‎.github/workflows/main.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: singularity-hpc
2+
3+
on:
4+
# This should run on a push to any branch except main, gh-pages, and binoc
5+
pull_request: []
6+
7+
jobs:
8+
test-render:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
13+
- name: Setup Python Environment
14+
run: conda create --quiet --name viz
15+
16+
- name: Lint python code
17+
run: |
18+
export PATH="/usr/share/miniconda/bin:$PATH"
19+
source activate viz
20+
conda install pandoc
21+
pip install -r requirements.txt
22+
make html
23+
24+
- name: Check Spelling
25+
uses: crate-ci/typos@592b36d23c62cb378f6097a292bc902ee73f93ef # version 1.0.4
26+
with:
27+
files: ./build/_html/*.html ./build/_html/about/ ./build/_html/auto_examples/

‎.github/workflows/update-contributors.yaml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Update Contributors
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
Update:
10+
name: Generate
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout Repository
14+
uses: actions/checkout@v3
15+
- name: Tributors Update
16+
uses: con/[email protected]
17+
env:
18+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19+
with:
20+
parsers: unset
21+
update_lookup: github
22+
log_level: DEBUG
23+
force: true
24+
threshold: 1
25+
run_twice: true
26+
27+
- name: Checkout New Branch
28+
env:
29+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
30+
BRANCH_AGAINST: "main"
31+
run: |
32+
printf "GitHub Actor: ${GITHUB_ACTOR}\n"
33+
export BRANCH_FROM="contributors/update-$(date '+%Y-%m-%d')"
34+
git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
35+
36+
BRANCH_EXISTS=$(git ls-remote --heads origin ${BRANCH_FROM})
37+
if [[ -z ${BRANCH_EXISTS} ]]; then
38+
printf "Branch does not exist in remote.\n"
39+
else
40+
printf "Branch already exists in remote.\n"
41+
exit 1
42+
fi
43+
git branch
44+
git checkout -b "${BRANCH_FROM}" || git checkout "${BRANCH_FROM}"
45+
git branch
46+
47+
git config --global user.name "github-actions"
48+
git config --global user.email "[email protected]"
49+
git status
50+
51+
if git diff-index --quiet HEAD --; then
52+
export OPEN_PULL_REQUEST=0
53+
printf "No changes\n"
54+
else
55+
export OPEN_PULL_REQUEST=1
56+
printf "Changes\n"
57+
git commit -a -m "Automated deployment to update contributors $(date '+%Y-%m-%d')"
58+
git push origin "${BRANCH_FROM}"
59+
fi
60+
61+
echo "OPEN_PULL_REQUEST=${OPEN_PULL_REQUEST}" >> $GITHUB_ENV
62+
echo "PULL_REQUEST_FROM_BRANCH=${BRANCH_FROM}" >> $GITHUB_ENV
63+
echo "PULL_REQUEST_TITLE=[tributors] ${BRANCH_FROM}" >> $GITHUB_ENV
64+
echo "PULL_REQUEST_BODY=Tributors update automated pull request." >> $GITHUB_ENV
65+
66+
- name: Open Pull Request
67+
uses: vsoch/[email protected]
68+
if: ${{ env.OPEN_PULL_REQUEST == '1' }}
69+
env:
70+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
71+
PULL_REQUEST_BRANCH: "main"

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
env
2+
_build

‎Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?= -j auto
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -j auto $(SPHINXOPTS) $(O)

‎README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# River Viz
2+
3+
_Visualization examples using River_
4+
5+
This is a repository of river visualizations to help guide you with using river!
6+
We use [sphinx-gallery](https://sphinx-gallery.github.io/stable/getting_started.html) for the
7+
examples and visualizations, and [sphinx-material](https://github.com/bashtage/sphinx-material/)
8+
for the template to match [https://riverml.xyz/](https://riverml.xyz/).
9+
10+
See our [contributing guide](contributing.md) for how to add an example, or
11+
12+
⭐️ [View the Interface](https://online-ml.github.io/viz/) ⭐️
13+
14+
15+
## 😁️ Contributors 😁️
16+
17+
We use the [all-contributors](https://github.com/all-contributors/all-contributors)
18+
tool to generate a contributors graphic below.
19+
20+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
21+
<!-- prettier-ignore-start -->
22+
<!-- markdownlint-disable -->
23+
24+
<!-- markdownlint-restore -->
25+
<!-- prettier-ignore-end -->
26+
27+
<!-- ALL-CONTRIBUTORS-LIST:END -->

‎_static/custom.css

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.o-tooltip--left:after{
2+
font-size: 0.8rem;
3+
}
4+
5+
.md-hero__inner {
6+
padding: 0px !important;
7+
}
8+
9+
/* Fix ugly mustard buttons! */
10+
div.sphx-glr-download a {
11+
background-color: #FFF;
12+
background-image: linear-gradient(to bottom, #FFF, #FFF);
13+
border: 1px solid #cccc;
14+
}
15+
16+
17+
div.sphx-glr-download a:hover {
18+
background-color: gold !important;
19+
}

‎_static/images/favicon.ico

116 KB
Binary file not shown.

‎_static/images/river_square.png

7.93 KB
Loading

0 commit comments

Comments
 (0)