Updated README and gitignore, moved usecas scripts in examples folder.

.gitignore

@@ -17,22 +17,15 @@ Tprofile.pdf
 .DS_Store
 .vscode
 __pycache__/
-rad_trans/socrates_code/*
-!rad_trans/socrates_code/.gitkeep
 nogit_*
-spectral_files/shared
+src/janus/data/spectral_files/shared
 fwl_janus.egg-info
 
-# Ignore SOCRATES code files
-rad_trans/socrates_code/*
-
 # Video files
 *.mp4
-spectral_files/sp_b318_HITRAN_a16_gen_original
-spectral_files/sp_b318_HITRAN_a16_2203/temp
-spectral_files/sp_b318_HITRAN_a16_2203
-socrates_2002.tar.xz
-set_rad_env
+src/janus/data/spectral_files/sp_b318_HITRAN_a16_gen_original
+src/janus/data/spectral_files/sp_b318_HITRAN_a16_2203/temp
+src/janus/data/spectral_files/sp_b318_HITRAN_a16_2203
 
 output/
 utils/*.ipynb*

README.md

@@ -17,17 +17,12 @@ https://proteus-code.readthedocs.io
 * LS - Laurent Soucasse ([email protected])
 
 ### Repository structure
-* `README.md`                          - This file
-* `JANUS.env`                          - Sets environment flags to run the code
-* `src/janus/SocRadConv.py`            - Main JANUS Python script
-* `src/janus/data/luminosity_tracks/`  - Stellar evolution data
-* `src/janus/data/spectral_files/`     - Spectral files for SOCRATES
-* `src/janus/modules/`                 - Utility python scripts
-* `src/janus/plotting_tools/`          - Plotting scripts
-* `src/janus/utils/`                   - Utility python scripts
-* `tests/demo_runaway_greenhouse.py`   - Demonstrate pure-steam runaway greenhouse OLR curve
-* `tests/demo_instellation.py`         - Calculate fluxes (and temperatures) for different instellations
-* `tools/`                             - Useful tools
+* `README.md`           - This file
+* `src/janus/data/`     - Janus data files
+* `src/janus/modules/`  - Utility python scripts
+* `src/janus/utils/`    - Utility python scripts
+* `examples/`           - Typical use scripts
+* `tools/`              - Useful tools
 
 ### Developer installation instructions
 1. Download and install Socrates
@@ -36,14 +31,11 @@ https://proteus-code.readthedocs.io
     * `./configure`
     * `./build-code`
     * `source set_rad_env`
+    * `cd ..`
 2. Download and install Janus
     * `git clone [email protected]:FormingWorlds/JANUS.git`
     * `cd JANUS`
     * `pip install -e .`
 
 ### Run instructions
-Only attempt to run JANUS after you have followed all of the instructions in INSTALL.md    
-If using a fresh shell, it is necessary to perform the following steps:     
-1. `source JANUS.env`    
-2. `conda activate janus`    
-Then you can run the code by running: `python SocRadConv.py`      
+In the examples folder you can find python scripts showing typical usecases/workflows of atmosphere modelling with Janus.