docs: remove old readme content and reference new pipeline repo #360
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cpaniaguam
requested changes
Nov 30, 2023
README.md
Outdated
| ## Fetch Data | ||
|
|
||
| The [`fetchdata.sh`](/scripts/fetchdata.sh) script requires the utilities [`gdal`](https://gdal.org/) and [`proj`](https://proj.org/). This repository includes a brewfile for ease of installation on MacOS. To install `gdal` and `proj` via homebrew, first [install homebrew](https://brew.sh/), then run `brew bundle install` | ||
| ## Using in a Pipeline |
There was a problem hiding this comment.
Suggested change
| ## Using in a Pipeline | |
| ## Interface for Pipeline Workflows |
README.md
Outdated
| ``` | ||
| snakemake -c<NUM CORES> | ||
| ``` | ||
| See the related tools at `https://github.com/WilhelmusLab/ice-floe-tracker-pipeline.git` for a Julia Command-line Interface to access all the source functions and templates for using the Cylc pipeline orchestrator. |
There was a problem hiding this comment.
Suggested change
| See the related tools at `https://github.com/WilhelmusLab/ice-floe-tracker-pipeline.git` for a Julia Command-line Interface to access all the source functions and templates for using the Cylc pipeline orchestrator. | |
| See related tools in the [IFTPipeline repo](https://github.com/WilhelmusLab/ice-floe-tracker-pipeline#ice-floe-tracker-pipeline) including a Julia Command-line Interface and templates that leverage the [Cylc](https://cylc.github.io/) pipeline orchestrator. |
| @@ -41,7 +42,6 @@ Instantiate the environment and run the tests: | |||
| (IceFloeTracker) pkg> test | |||
| ``` | |||
|
|
|||
|
|
|||
| ## Notebooks | |||
There was a problem hiding this comment.
We are not using Pluto notebooks so I think this section could also be deleted.
There was a problem hiding this comment.
We do have some Jupyter notebooks though, I added a statement just alerting users that they are available, but it would be up to the user to figure out how run a .ipynb.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #360 +/- ##
=======================================
Coverage 90.73% 90.73%
=======================================
Files 29 29
Lines 950 950
=======================================
Hits 862 862
Misses 88 88 ☔ View full report in Codecov by Sentry. |
cpaniaguam
previously approved these changes
Nov 30, 2023
README.md
Outdated
| ## Fetch Data | ||
|
|
||
| The [`fetchdata.sh`](/scripts/fetchdata.sh) script requires the utilities [`gdal`](https://gdal.org/) and [`proj`](https://proj.org/). This repository includes a brewfile for ease of installation on MacOS. To install `gdal` and `proj` via homebrew, first [install homebrew](https://brew.sh/), then run `brew bundle install` | ||
| There are Jupyter notebooks in `IceFloeTracker.jl` that can be used as examples to access some of the image processing and tracking functions, available at `IceFloeTracker.jl/notebooks`. |
There was a problem hiding this comment.
Suggested change
| There are Jupyter notebooks in `IceFloeTracker.jl` that can be used as examples to access some of the image processing and tracking functions, available at `IceFloeTracker.jl/notebooks`. | |
| There are Jupyter notebooks illustrating the main image processing and tracking functions in the `/notebooks` folder. |
|
Minor update after approval |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just some cleanup and adding a reference to the IFTPipeline in this README.