https://github.com/afm-spm/topostats-training
TopoStats Training Material
https://github.com/afm-spm/topostats-training
afm english image-processing lesson pre-alpha
Last synced: 7 months ago
JSON representation
TopoStats Training Material
- Host: GitHub
- URL: https://github.com/afm-spm/topostats-training
- Owner: AFM-SPM
- License: other
- Created: 2024-01-08T15:00:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T00:26:14.000Z (7 months ago)
- Last Synced: 2025-04-01T01:28:33.619Z (7 months ago)
- Topics: afm, english, image-processing, lesson, pre-alpha
- Homepage: https://afm-spm.github.io/topostats-training
- Size: 2.55 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TopoStats AFM Image Processing Tutorial
This lesson uses [The Carpentries Workbench][workbench] to develop training material for the [TopoStats][topostats]
Atomic Force Microscopy batch image processing software.
The course material is rendered and available [online][topostats-training].
## Code of Conduct
Please refer to the `CODE_OF_CONDUCT.md` at the top level of this repository.
## Contributing
Contributions are welcome, please see the `CONTRIBUTING.md` file at the top level of this repository.
### Building Locally
To render these pages locally you need to have [R][r] installed. Instructions are
[available](https://carpentries.github.io/workbench/#installation) but some additional steps have been taken to make
sure the environment is reproducible.
Once you have installed the dependencies you can render the pages locally by starting R in the project root and
running...
``` r
sandpaper::serve()
```
This will build the pages and start a local web-server in R and open it in your default browser. These pages are "live"
and as you edit and save them the web-site will be rebuilt and the pages updated.
## Licensing
Please refer to the `LICENSING.md` at the top level of this repository.
[r]: https://www.r-project.org/
[topostats]: https://afm-spm.github.io/topostats
[topostats-training]: https://afm-spm.github.io/topostats-training
[workbench]: https://carpentries.github.io/sandpaper-docs/