Merge pull request #29 from ggebbie/sparsify

Sparsify

README.md

@@ -1,11 +1,11 @@
 # ECCOtour
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ggebbie.github.io/ECCOtour.jl/stable)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ggebbie.github.io/ECCOonPoseidon.jl/dev)
-[![Build Status](https://github.com/ggebbie/ECCOonPoseidon.jl/workflows/CI/badge.svg)](https://github.com/ggebbie/ECCOonPoseidon.jl/actions)
-[![Coverage](https://codecov.io/gh/ggebbie/ECCOonPoseidon.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/ggebbie/ECCOonPoseidon.jl)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ggebbie.github.io/ECCOtour.jl/dev)
+[![Build Status](https://github.com/ggebbie/ECCOtour.jl/workflows/CI/badge.svg)](https://github.com/ggebbie/ECCOtour.jl/actions)
+[![Coverage](https://codecov.io/gh/ggebbie/ECCOtour.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/ggebbie/ECCOtour.jl)
 
-Analysis of ECCO version 4 release 4 using output from Poseidon @ WHOI
+Take a self-guided tour of the ECCO version 4 release 4 ocean reanalysis product. 
 
 # Getting started
 
@@ -15,34 +15,28 @@ Install julia-mode, julia-repl, and magit \
 Skip the next 5 steps if you have already cloned the repository \
 `M-x magit-clone` \
 Select `u` to clone from url\
-Enter ` https://github.com/ggebbie/ECCOonPoseidon.jl` as url to clone \
+Enter ` https://github.com/ggebbie/ECCOtour.jl` as url to clone \
 Select `y` in response to `remote.pushDefault' to "origin"?` \
 Clone to your favorite location and rename project if necessary \
-Go to any directory in the project: `C-x C-f ECCOonPoseidon.jl`\
+Go to any directory in the project: `C-x C-f ECCOtour.jl`\
 Then activate the project and initialize a julia session: `C-c C-a`
 
 * from the Julia REPL
 
 `;`\
-`git clone https://github.com/ggebbie/ECCOonPoseidon.jl # only do this the first time on each machine`\
-`cd ECCOonPoseidon.jl`\
+`git clone https://github.com/ggebbie/ECCOtour.jl # only do this the first time on each machine`\
+`cd ECCOtour.jl`\
 `]`\
 `activate .`\
 `instantiate # only do this the first time on each machine`\
-To verify you are in the project environment, `]` should return `(ECCOonPoseidon) pkg>`\
+To verify you are in the project environment, `]` should return `(ECCOtour) pkg>`\
 Type backspace to return to command mode.
 
 * Using an editor like Atom/Juno or Visual Studio Code, activate the environment on one of the frame panels. The default environment is @v1.x and should be changed.
 
-# Running a script (not interactively)
-
-`cd ECCOonPoseidon.jl`\
-`julia --project=@. scripts/experiment_divergence.jl`
-
 # Functions
-Check `export` line in src/ECCOonPoseidon.jl for list of available functions.
+Check `export` line in src/ECCOtour.jl for list of available functions.
 
 # Directory structure
-- `examples`: code snippets useful for making new scripts and functions
+- `src`: source code
 - `test`: testing routines, currently empty
-- `scripts`: production-ready scripts

docs/make.jl

@@ -1,16 +1,16 @@
-using Reemergence
+using ECCOtour
 using Documenter
 
-DocMeta.setdocmeta!(Reemergence, :DocTestSetup, :(using Reemergence); recursive=true)
+DocMeta.setdocmeta!(ECCOtour, :DocTestSetup, :(using ECCOtour); recursive=true)
 
 makedocs(;
-    modules=[Reemergence],
+    modules=[ECCOtour],
     authors="G Jake Gebbie",
-    repo="https://github.com/ggebbie/Reemergence.jl/blob/{commit}{path}#{line}",
-    sitename="Reemergence.jl",
+    repo="https://github.com/ggebbie/ECCOtour.jl/blob/{commit}{path}#{line}",
+    sitename="ECCOtour.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://ggebbie.github.io/Reemergence.jl",
+        canonical="https://ggebbie.github.io/ECCOtour.jl",
         assets=String[],
     ),
     pages=[
@@ -19,5 +19,5 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/ggebbie/Reemergence.jl",
+    repo="github.com/ggebbie/ECCOtour.jl",
 )