Skip to content

Readme updates #32

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.

Sign up for GitHub

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

Merged
bkm82 merged 2 commits into from
Feb 11, 2025
Merged

Readme updates #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
018b549
docs: update readme to point users to pre-compiled binarys
bkm82 Feb 11, 2025
883681e
docs: remove the completed plan to add windows to the CI/CD pipeline
bkm82 Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions README.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ You cannot compute FTLE and particle trajectories at the same time. The feature

** Usage
*** Quick Start
**** Download or Build the Latest Verison of flowVC

#+begin_quote
[!Note]
Grab a pre-compiled binary for Windows Linux or macOS [[https://github.com/bkm82/flowVC/releases/latest][here]]
Alternatly build it from source as shown below
#+end_quote

**** Create the input data files
#+begin_quote
[!Note]
Expand All @@ -58,17 +66,9 @@ You cannot compute FTLE and particle trajectories at the same time. The feature
#+end_quote


**** Download or Build the Latest Verison

#+begin_quote
[!Note]
For linux, get the pre-compiled binary [[https://github.com/bkm82/flowVC/releases/latest][here]]
For windos and mac, see below how to compile the code from source
#+end_quote

**** Run the code
**** Run the code from the command line
#+begin_src shell
./flowvc.out settings_file
./flowvc.out settings_file.in
#+end_src

**** Report any Issues
Expand All @@ -77,7 +77,7 @@ You cannot compute FTLE and particle trajectories at the same time. The feature
** Installation

*** Build From Source
If you are not on ubuntu, or you want to edit / modify the code, there are various ways to compile the code from source.
If you want to edit / modify the code, there are various ways to compile the code from source.

**** Ceedling

Expand Down Expand Up @@ -118,7 +118,10 @@ If you are not on ubuntu, or you want to edit / modify the code, there are vario

**** Docker
Alternatly, there is a docker image has the tooling installed.

#+begin_quote
[!Warning]
The method shown here should work, but i havent tested it extensivly.
#+end_quote

***** Install [[https://docs.docker.com/engine/install/][Docker]]
***** Clone the repository
Expand Down Expand Up @@ -148,11 +151,6 @@ Alternatly, there is a docker image has the tooling installed.
#+end_src
***** This will create the ./build/release/flowVC.out executable.

#+begin_quote
[!Warning]
This method compiles the code using a linux (Ubuntu) docker container, if you you are on another operating system, you might need to run the program through that docker container
#+end_quote

#+begin_src shell
docker run -it --rm -v .:/home/dev/project throwtheswitch/madsciencelab:latest
.build/release/flowVC.out <input file>
Expand All @@ -178,4 +176,4 @@ Valid types are fix, feat, BREAKING CHANGE, build, chore, ci, docs, style, refac


*** Planned Updates
**** TODO Add support for windows in the CI/CD pipeline