diff --git a/README.md b/README.md index 3ec45c8..c3e1cdd 100644 --- a/README.md +++ b/README.md @@ -16,21 +16,14 @@ See [here](https://julialang.org/downloads/platform/#optional_add_julia_to_path) We will now proceed to the installation of the `OrbitalElements` library. -**Note on working with environments.** *By default packages are added to the default environment at ~/.julia/environments/v1.#.* -*It is however easy to create other, independent, projects.* -*If you want to install the* `OrbitalElements` *package in a different/test environment, first create a folder to host the environment files (Project.toml and Manifest.toml which will be created later on).* -*Then, for every command line invoking Julia, use* `julia --project=/path/to/my_env` *instead of* `julia` *alone.* -*Note that packages will always be cloned in ~/.julia/packages but only accessible in your project's context.* -*A procedure to fully uninstall the package is described at the end of this readme.* +**Caution:** If you wish to exercise extra care to prevent any interference with other installed libraries (e.g., avoiding updates), please refer to the "Notes on working with environments" section below. Install the `OrbitalElements` library by running ``` julia -e 'using Pkg; Pkg.add(url="https://github.com/JuliaStellarDynamics/OrbitalElements.jl.git")' ``` -*If you want to work in a given environment, do not forget the* `--project=/path/to/my_env` *option.* - -An introduction example is given in `example/test_OrbitalElements.jl`. +An introduction example is given in `examples/test_OrbitalElements.jl`. Download the file by running: ``` wget https://raw.githubusercontent.com/JuliaStellarDynamics/OrbitalElements.jl/main/examples/test_OrbitalElements.jl @@ -39,7 +32,6 @@ Then run the code with the following command ``` julia test_OrbitalElements.jl ``` -*If you want to work in a given environment, do not forget the* `--project=/path/to/my_env` *option.* This example will first install some required libraries (`Plots`, `LaTeXStrings`) and their dependencies. These installations might take up to 4 minutes. @@ -51,12 +43,23 @@ and `ForwardBackwardErrors.png`. ![`Forward+backward errors`](examples/ForwardBackwardErrors_original.png) +--- +### Note on working with environments + +By default, packages are added to the default environment at ~/.julia/environments/v1.#. +It is however easy to create other, independent, projects. +If you want to install the `OrbitalElements` package in a different/test environment, first create a folder to host the environment files (Project.toml and Manifest.toml which will be created later on). +Then, for every command line invoking Julia, use `julia --project=/path/to/my_env` instead of `julia` alone. + +*Note that packages will always be cloned in ~/.julia/packages but only accessible in your project's context.* +*A procedure to fully uninstall the package is described at the end of this readme.* + --- ### Interactive notebook If you prefer interactive Jupyter notebooks, you will need to install `IJulia` following these [instructions](https://github.com/JuliaLang/IJulia.jl). -The interactive introduction example is then given in `example/test_OrbitalElements.ipynb`. +An interactive introduction example is then in [`examples/test_OrbitalElements.ipynb`](examples/test_OrbitalElements.ipynb). --- ### Without installing Julia @@ -78,7 +81,6 @@ First start by removing the package from the environment by running ``` julia -e 'using Pkg; Pkg.rm("OrbitalElements");' ``` -*If you worked in a given environment, do not forget the* `--project=/path/to/my_env` *option.* Following the same syntax, you can also remove the `Plots` and `LaTeXString` packages installed for the example if you want to. @@ -88,13 +90,13 @@ Then to fully erase the package (installed in ~/.julia), run ``` julia -e 'using Pkg; using Dates; Pkg.gc(collect_delay=Day(0));' ``` -*No need for the* `--project=/path/to/my_env` *option here anyway!* +*No need for the* `--project=/path/to/my_env` *option here !* It will erase all the packages which are not known in any of your "active" (i.e., for which the Manifest.toml file is reachable) project/environments, in particular `OrbitalElements`. --- ## Authors -Mike Petersen - @michael-petersen - michael.petersen@roe.ac.uk +Mike Petersen - [@michael-petersen](https://github.com/michael-petersen) - michael.petersen@roe.ac.uk -Mathieu Roule - @MathieuRoule - roule@iap.fr +Mathieu Roule - [@MathieuRoule](https://github.com/MathieuRoule) - roule@iap.fr