diff --git a/README.md b/README.md index ab4035b..70fcc12 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## What's in this repository? This repository contains the scripts and files related to the development of a Marine Heatwave Simulator (MHWsim) using a Raspberry Pi. -This repository is maintained by Amelia Ritger (GitHub: [@ameliaritger](https://github.com/ameliaritger)) at the University of California, Santa Barbara in the Hofmann Lab, Department of Ecology, Evolution, & Marine Biology. Please direct any questions or comments about this repository to [Amelia Ritger](mailto:aritger@ucsb.edu). +This repository is maintained by Amelia Ritger (GitHub: [@ameliaritger](https://github.com/ameliaritger)) at the University of California, Santa Barbara in the Department of Ecology, Evolution, & Marine Biology. Please direct any questions or comments about this repository to [Amelia Ritger](mailto:aritger@ucsb.edu). ## How is this repository structured? ``` @@ -13,23 +13,22 @@ This repository is maintained by Amelia Ritger (GitHub: [@ameliaritger](https:// | ├── media/ # directory containing media files for project repo | -├── simulator/ # directory containing resources for building and running the RPi MHWsim system -| └── code/ # directory with scripts for the MHWsim -| └── Alert.py # script for sending SMS alerts -| └── CleanUp.py # script for saving data, clearing lists/variables, and going to sleep -| └── IO_ctrl.py # script for initializing relay board -| └── MHWRamp.py # script for ramping up and down temperatures at start/end of MHW event -| └── MHWsim.py # script for initializing MHWsim objects, parameters and then running the MHWsim -| └── Memory.py # script for constructing and saving to .csv file -| └── PID.py # script for Proportional–integral–derivative controller algorithm -| └── SensorAverage.py # script for averaging multiple consecutive temperature probe readings and calculating the average temperature across replicates -| └── SensorInfo.py # script to enter temperature probe ROM numbers and location identification, and calibration values for each probe -| └── Temperature.py # script for reading temperature probes -| └── main.py # main script to run all code associated with MHWsim -| └── mhw_profile.csv # MHWsim experiment data, required for initial code test +├── code/ # directory with scripts for the MHWsim +| └── Alert.py # script for sending SMS alerts +| └── CleanUp.py # script for saving data, clearing lists/variables, and going to sleep +| └── IO_ctrl.py # script for initializing relay board +| └── MHWRamp.py # script for ramping up and down temperatures at start/end of MHW event +| └── MHWsim.py # script for initializing MHWsim objects, parameters and then running the MHWsim +| └── Memory.py # script for constructing and saving to .csv file +| └── PID.py # script for Proportional–integral–derivative controller algorithm +| └── SensorAverage.py # script for averaging multiple consecutive temperature probe readings and calculating the average temperature across replicates +| └── SensorInfo.py # script to enter temperature probe ROM numbers and location identification, and calibration values for each probe +| └── Temperature.py # script for reading temperature probes +| └── main.py # main script to run all code associated with MHWsim +| └── mhw_profile.csv # MHWsim experiment data, required for initial code test | -| └── documentation/ # directory containing MHWsim system build documentation -| └── rpiMHWsimConstruction.docx # document for building the RPi MHWsim system +├── documentation/ # directory containing MHWsim system build documentation +| └── rpiMHWsimConstruction.docx # document for building the RPi MHWsim system | ├── .gitignore | diff --git a/simulator/code/Alert.py b/code/Alert.py similarity index 100% rename from simulator/code/Alert.py rename to code/Alert.py diff --git a/simulator/code/CleanUp.py b/code/CleanUp.py similarity index 100% rename from simulator/code/CleanUp.py rename to code/CleanUp.py diff --git a/simulator/code/IO_ctrl.py b/code/IO_ctrl.py similarity index 100% rename from simulator/code/IO_ctrl.py rename to code/IO_ctrl.py diff --git a/simulator/code/MHWRamp.py b/code/MHWRamp.py similarity index 100% rename from simulator/code/MHWRamp.py rename to code/MHWRamp.py diff --git a/simulator/code/MHWsim.py b/code/MHWsim.py similarity index 100% rename from simulator/code/MHWsim.py rename to code/MHWsim.py diff --git a/simulator/code/Memory.py b/code/Memory.py similarity index 100% rename from simulator/code/Memory.py rename to code/Memory.py diff --git a/simulator/code/PID.py b/code/PID.py similarity index 100% rename from simulator/code/PID.py rename to code/PID.py diff --git a/simulator/code/SensorAverage.py b/code/SensorAverage.py similarity index 100% rename from simulator/code/SensorAverage.py rename to code/SensorAverage.py diff --git a/simulator/code/SensorInfo.py b/code/SensorInfo.py similarity index 100% rename from simulator/code/SensorInfo.py rename to code/SensorInfo.py diff --git a/simulator/code/Temperature.py b/code/Temperature.py similarity index 100% rename from simulator/code/Temperature.py rename to code/Temperature.py diff --git a/simulator/code/main.py b/code/main.py similarity index 100% rename from simulator/code/main.py rename to code/main.py diff --git a/simulator/code/mhw_profile.csv b/code/mhw_profile.csv similarity index 100% rename from simulator/code/mhw_profile.csv rename to code/mhw_profile.csv diff --git a/simulator/documentation/MHWsimConstruction.docx b/documentation/MHWsimConstruction.docx similarity index 100% rename from simulator/documentation/MHWsimConstruction.docx rename to documentation/MHWsimConstruction.docx