reformated repo

torimcd · Aug 3, 2020 · 5df3841 · 5df3841
1 parent 60d7783
commit 5df3841
Show file tree

Hide file tree

Showing 17 changed files with 373 additions and 218 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/PARTICLE_ON_SPHEROID_EARTH.bas → GW-BASIC/7-1.bas b/PARTICLE_ON_SPHEROID_EARTH.bas → GW-BASIC/7-1.bas
diff --git a/CORIOLIS.BAS → GW-BASIC/CORIOLIS.BAS b/CORIOLIS.BAS → GW-BASIC/CORIOLIS.BAS
diff --git a/README.md b/README.md
@@ -1,2 +1,34 @@
 # coriolis-sm
-Updated code examples from Stommel &amp; Moore's "An Introduction to the Coriolis Force"
+This repository contains updated code examples from "An Introduction to the Coriolis Force" by Stommel & Moore (1989).
+Programs were rewritten in Python from the original GW-BASIC. 
+
+
+
+RUN THE PROGRAMS IN A JUPYTER NOTEBOOK
+--------------------------------------
+Standalone Jupyter Notebook files (.ipynb) for each exercise are available in the notebooks directory. These contain full inline explanations including notes from the original text to explain each program.
+
+
+
+RUN THE PYTHON CODE FILES
+-------------------------
+Pythoon code files (.py) for the full set of exercises are available in the code directory. There are comments explaining some of the code but see the notebooks for more verbose explanations. 
+
+The coriolis_tools module contains the subroutines that are shared among multiple exercises, in the spirit of how the original program was designed. Programs that use tools from this module will fail unless it is in the same directory that the program is run from.
+
+
+
+RUN THE ORIGINAL PROGRAMS IN GW-BASIC
+----------------------------------
+
+The original GW-BASIC programs (.bas files) can be found in the GW-BASIC directory. These programs can be run in the PC-BASIC emulator (https://robhagemans.github.io/pcbasic/) which is available for Windows, OSX, and Linux. 
+
+CORIOLIS.bas is the full program containing all of the exercises from the book as described in section 1.2 of Stommel and Moore (1989).
+Individual exercises are also provided and contain all of the subroutines that they require individually. 
+
+ALong with each individual exercise is a text file documenting in plain language the algorithm used - ie, what they programmed in BASIC. These are the notes I used to rewrite the programs in Python, and can be used to extend the programs to other languages as desired.
+
+To run the programs in PCBASIC, copy the .bas file to your home directory. On Windows this is usually C:\Users\YourName. On OSX and Linux this is ~
+Refer to the documentation (https://robhagemans.github.io/pcbasic/doc/1.2/#mounting) in case your system is configured differently or you installed PC-BASIC to a different location.
+
+Load the program into memory by typing LOAD "FILENAME" into the PC-BASIC terminal, where filename is the name of the .bas file you want to run. Then type RUN to start the program.
diff --git a/animation_example.py b/animation_example.py
diff --git a/code/.DS_Store b/code/.DS_Store
diff --git a/coriolis/1-1.py → code/1-1.py b/coriolis/1-1.py → code/1-1.py
diff --git a/coriolis/spheroid_earth/exer7-1.py → code/7-1.py b/coriolis/spheroid_earth/exer7-1.py → code/7-1.py
diff --git a/coriolis/coriolis_tools/tools.py → code/coriolis_tools/tools.py b/coriolis/coriolis_tools/tools.py → code/coriolis_tools/tools.py
diff --git a/coriolis/1-1_updated.py b/coriolis/1-1_updated.py
diff --git a/coriolis/coriolis_tools/__init__.py b/coriolis/coriolis_tools/__init__.py
diff --git a/coriolis/readme.txt b/coriolis/readme.txt
diff --git a/coriolis/spheroid_earth/coriolis.code-workspace b/coriolis/spheroid_earth/coriolis.code-workspace
diff --git a/coriolis/test/__init__.py b/coriolis/test/__init__.py
diff --git a/coriolis/test/test_code.py b/coriolis/test/test_code.py
diff --git a/coriolis/notebooks/1.1.ipynb → notebooks/1.1.ipynb b/coriolis/notebooks/1.1.ipynb → notebooks/1.1.ipynb
diff --git a/notebooks/7-1.ipynb b/notebooks/7-1.ipynb