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

Docs - scenarios for using the Julia functions with outside inputs #340

Open
tdivoll opened this issue Sep 7, 2023 · 3 comments
Open

Docs - scenarios for using the Julia functions with outside inputs #340

tdivoll opened this issue Sep 7, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tdivoll
Copy link
Collaborator

tdivoll commented Sep 7, 2023

Maybe via the repo documentation page, create some scenarios so users know how to work with the Jupyter notebooks if they already have some images or data from elsewhere.

@tdivoll tdivoll added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 7, 2023
@danielmwatkins
Copy link
Contributor

I'm working on putting together a tutorial for some use cases. I'd like to learn more about how the documentation software works so I know how to add pages. Ideally, I can write a page describing the idea of the algorithm with a schematic of how the different modules work together. In addition, I'd like to add a quick-start section for the top-level functions, a tutorials section, and a references section. This is mainly stuff we can do if we can get pointers on how the documentation gets built.

@cpaniaguam
Copy link
Member

@danielmwatkins The relevant files are under /docs. You'll see another Project.toml file there as building the doc html files requires the Documenter.jl package which is not an IceFloeTracker.jl dependency.

@danielmwatkins
Copy link
Contributor

danielmwatkins commented Nov 15, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants