search

Exo-TiC / ExoTiC-ISM

This is a repository for the reduction pipeline detailed in Wakeford, et al., 2016, ApJ. The method implements marginalization across a series of models to represent stochastic models for observatory and instrument systematics. This is primarily for HST WFC3, however, may be extended to STIS in the future.
MIT License
8 stars 6 forks source link

README ordering #76

Closed hrwakeford closed 4 years ago

hrwakeford commented 4 years ago

Overall setup and prerequisite need to come first in the set-up steps. If you have a new user like myself they will just blindly follow the steps in the Quickstart and then find that they have not installed everything in its own environment yet and have to redo things.

If this is not the case and I am missing what the point of the prerequisite and QuickStart are for then we need to improve the language to make it clearer.

hrwakeford commented 4 years ago

Once I am happy with the README we will make the repository public, but still working in Develop.

ivalaginja commented 4 years ago

Overall setup and prerequisite need to come first in the set-up steps. If you have a new user like myself they will just blindly follow the steps in the Quickstart and then find that they have not installed everything in its own environment yet and have to redo things.

This is the exact intention of the Quickstart section! It is intended as a set of instructions that can be followed blindly and have a result at the end, without having to go into the details of the setup. This is why this section starts with the cloning of the repo, then creates a conda env out of the box and then provides instructions on the fastest way to make the main script run. Anyone who does need the details can look at the readme sections after, e.g. a more thorough description of system prerequisites and how to use the repo.

I agree that if this is confusing, we need to reword it. Would you have any suggestions on how to make things clearer?

hrwakeford commented 4 years ago

Okay. So I am having trouble with the end of the QuickStart where after the clone/forking section it jumps right into the set-up of running the code without telling them that. I would add a small title on

How to run the code/module/something

Also it has become unclear what the different paths are and the rules on setting those up. Most will not want their data to be inside the GitHub repo as we have in the example. Perhaps we should state clearly

we have set up an example inside the repo which can be run with the following path names

[data_paths]
local_path = /Users/<YourName>/<Folder>/ExoTiC-ISM/
data_path = data
output_path = /Users/<YourName>/<Folder>/ExoTiC-ISM/outputs/
current_model = W17
run_name = W17_G141_lightcurve_test_fit_time

If you want to run this on data stored external to the path replace the following with the correct path directions

[data_paths]
local_path = /Users/<YourName>/<Documents>/<Transit_data>/<Planet>/
data_path = <Lightcurves>/
output_path = /Users/<YourName>/<Documents>/<Transit_data>/<Planet>/<Lightcurves>/<Results>
current_model = W17
run_name = W17_G141_lightcurve_test_fit_time
ivalaginja commented 4 years ago

Good point, I'll make sure to update that.

ivalaginja commented 4 years ago

Closed with #77