@@ -10,20 +10,34 @@ nav_order: 0
1010This guide is maintained by the scientific Python community for the benefit of
1111fellow scientists and research software engineers.
1212
13- ** Learn the essentials .** Do you have a pile of scientific Python scripts or
13+ ** Start at the basics .** Do you have a pile of scientific Python scripts or
1414Jupyter notebooks that are becoming unwieldy? Are changes to some parts of your
1515code accidentally breaking other parts of your code? Do you want to more
1616maintainable, reusable, and shareable form? Start at the
1717[ tutorial] ({% link pages/tutorials/index.md %}).
1818
19- ** Learn recommended tools and best practices.** [ Topical
20- guides] ({% link pages/guides/index.md %}) provide task-based instruction on
21- topics that scientists and research software engineers may encounter as their
22- projects evolve and grow. This covers everything from writing and building
23- documentation to modern Python packaging. This comes with a
24- [ copier] [ ] /[ cookiecutter] [ ] template for making new repos,
25- [ scientific-python/cookie] [ ] , and [ sp-repo-review] [ ] , a tool for comparing your
26- repository with the guidelines, runnable in WebAssembly.
19+ ** Learn recommended tools and best practices.** [ Topical guides] ({% link
20+ pages/guides/index.md %}) provide task-based instruction on topics that scientists
21+ and research software engineers may encounter as their projects evolve and grow.
22+ This covers [ modern packaging] [ ] , [ style checking] [ ] , [ testing] [ ] , [ documentation] [ ] ,
23+ [ static typing] [ ] , [ CI] [ ] , and much more!
24+
25+ {: .highlight-title }
26+
27+ > New project template
28+ >
29+ > This guide comes with a [ copier] [ ] /[ cookiecutter] [ ] /[ cruft] [ ] template for
30+ > making new repos, [ scientific-python/cookie] [ ] . Twelve build backends
31+ > including compiled backends, generation tested in Nox, and kept in-sync with
32+ > the guide.
33+
34+ {: .important-title }
35+
36+ > Checking an existing project
37+ >
38+ > We provide [ sp-repo-review] [ ] , a set of [ repo-review] [ ] checks for comparing
39+ > your repository with the guidelines, runnable right in the guide via
40+ > WebAssembly! All checks point to a linked badge in the guide.
2741
2842** Learn to write better research code.** A high-level document on
2943[ principles] ({% link pages/principles/index.md %}) provides advice based on the
@@ -38,15 +52,24 @@ Python packages.
3852## Related Resources
3953
4054This guide does _ not_ cover the basics of Python itself or the scientific Python
41- libraries. We recommend the [ SciPy Lecture Notes] ( https://scipy-lectures.org/ ) .
55+ libraries; it focuses on making or maintaining a package. We recommend the
56+ [ SciPy Lecture Notes] ( https://scipy-lectures.org/ ) if you want info.
4257
4358This guide also does not cover version control, but it is essential to have a
4459basic facility with git to use these tools successfully. We recommend the
4560[ Software Carpentry lesson on git] ( https://swcarpentry.github.io/git-novice/ ) .
4661
4762<!-- prettier-ignore-start -->
4863[ scientific-python/cookie ] : https://github.com/scientific-python/cookie
49- [ sp-repo-review] : {% link pages/guides/repo_review.md %}
50- [ copier ] : https://copier.readthedocs.io
51- [ cookiecutter ] : https://cookiecutter.readthedocs.io
64+ [ modern packaging] : {% link pages/guides/packaging_simple.md %}
65+ [ style checking] : {% link pages/guides/style.md %}
66+ [ testing] : {% link pages/guides/pytest.md %}
67+ [ documentation] : {% link pages/guides/docs.md %}
68+ [ static typing] : {% link pages/guides/mypy.md %}
69+ [ ci] : {% link pages/guides/gha_pure.md %}
70+ [ sp-repo-review] : {% link pages/guides/repo_review.md %}
71+ [ repo-review ] : https://repo-review.readthedocs.io
72+ [ copier ] : https://copier.readthedocs.io
73+ [ cookiecutter ] : https://cookiecutter.readthedocs.io
74+ [ cruft ] : https://cruft.github.io/cruft
5275<!-- prettier-ignore-end -->
0 commit comments