Skip to content

Commit 65b79c7

Browse files
nfahlgrennfahlgren
authored
Initial commit
0 parents  commit 65b79c7

File tree

11 files changed

+2102
-0
lines changed

11 files changed

+2102
-0
lines changed

‎.github/workflows/ci-tests.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: test-pr
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
# The branches below must be a subset of the branches above
8+
branches: [ main ]
9+
schedule:
10+
- cron: "0 0 1 * *"
11+
12+
jobs:
13+
build:
14+
runs-on: ${{ matrix.os }}
15+
strategy:
16+
matrix:
17+
python-version: ["3.11"]
18+
os: [ubuntu-latest]
19+
env:
20+
OS: ${{ matrix.os }}
21+
PYTHON: ${{ matrix.python-version }}
22+
23+
steps:
24+
- uses: actions/checkout@main
25+
- name: Set up Python ${{ matrix.python-version }}
26+
uses: actions/setup-python@main
27+
with:
28+
python-version: ${{ matrix.python-version }}
29+
- name: Install dependencies
30+
run: |
31+
python -m pip install --upgrade pip
32+
pip install pytest jupyter nbconvert
33+
pip install -r requirements.txt
34+
- name: "Build notebooks"
35+
run: |
36+
pytest -v tests/tests.py

‎.gitignore‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
# PyCharm
132+
.idea
133+
134+
# VScode
135+
.vscode
136+
137+
# macOS
138+
.DS_Store

‎LICENSE‎

Lines changed: 157 additions & 0 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Tutorial Title
2+
3+
Description of tutorial. (ex. Try out our interactive tutorial! Learn how to ... using PlantCV.)
4+
5+
Create a Binder launch button:
6+
7+
1. Copy the GitHub repo URL
8+
2. Go to https://mybinder.org
9+
3. Fill in the tutorial URL
10+
4. Copy the Markdown code for the button
11+
5. Delete these meta-instructions, optionally replace with your own.
12+
6. Launch to build the environment
13+
14+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/danforthcenter/plantcv-tutorial-template/HEAD)
15+
16+
Create a Google Colab button:
17+
18+
1. Copy the markdown below these instructions to the README section below the Binder button.
19+
2. Replace {repo_name} with the name of the repository you want a button made for.
20+
3. Make sure you have created the Google Colaboratory notebook for the tutorial so the button is correctly linked.
21+
22+
[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/danforthcenter/{repo_name}/blob/main/index-Colab.ipynb)
23+
24+
Create a GitHub Source button:
25+
(Omit this step if you are working GitHub tutorial repo README)
26+
27+
1. Copy the GitHub repo URL
28+
2. Go to https://shields.io/badges/static-badge
29+
3. On the right-side panel, select ***+Show optional parameters***
30+
4. Modify the parameters below to create a uniform button:
31+
- *badgecontent*: Open in GitHub-black
32+
- *logo*: github
33+
5. Select Markdown from the options of code.
34+
6. Modify the Markdown code to make it a clickable link using the following schema:
35+
- [![Static Badge](Shields.io URL)](GitHub repo URL)
36+
37+
[![Static Badge](https://img.shields.io/badge/Open%20on%20GitHub-black?logo=github)](https://github.com/danforthcenter/plantcv-tutorial-template)
38+
39+
## Tutorial tags/keywords
40+
41+
tag1, tag2, (e.g. data type, species featured, algorithm, etc) ...
42+
43+
## Citations
44+
45+
Optional.
46+
47+
[![test-pr](https://github.com/danforthcenter/plantcv-tutorial-template/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/danforthcenter/plantcv-tutorial-template/actions/workflows/ci-tests.yml)

‎apt.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
freeglut3-dev

‎img/seedheads.JPEG‎

1.09 MB
Loading

0 commit comments

Comments
 (0)