Repository for the early-onset flare trigger system that will be utilized in the FOXSI and HI-C lauches.
Either
- Download the
flarepredrepository manually (<> Code>>Download ZIP) and place in a directory of your choice; or - navigate to that directory on your machine in the command line and use
git clone https://github.com/pet00184/flarepred.git.
You now have the flarepred package.
To avoid polluting your base python environemnt let's create a virtual Python environment to work in.
-
Conda [recommended]
We can create the environment with Conda/Miniconda where we can just type
conda create -n flarepred-env python=3.11.3 pipin the command line.- Now we can activate the environment with
conda activate flarepred-env; and - deactivate with
conda deactivate.
(See here for information on installing miniconda.)
- Now we can activate the environment with
-
PIP
Another way is just to use PIP directly to create the virtual environment; however, more set-up is needed.
First, ensure Python 3.11 is installed on your machine. A way to do this is with Homebrew via
brew install python@3.11
It should then be possible to create a virtual environment with with this specific version of Python using
python3.11 -m venv flarepred-env
After this, in the Mac/Unix terminal, the environment
- can be activated with
source env/bin/activateor, if the correct paths aren't set-up,source .../env/bin/activate; and - can be deactivated with
deactivate.
where
...here represents the location of the virtual environment. (See here for more information on working with Python environments set-up this way.)You may need to find where the virtual environment is saved. I had to search for the environment but depending how paths are set-up it may be obvious. In this example, the environment will be in a folder called
flarepred-envsomewhere.
Make sure you are in the flarepred directory and have the activated the virtual environment, type pip install -r requirements.txt. This install all the required packages used in flarepred.
Now, as long as you are in your virtual environment, you can use the methods in flarepred without issue while in any directory
-
While in any directory with the virtual environment activated, you can run
python3 .../flarepred/RealTime/run_realtime_algorithm.py,
where
...is the location of theflarepreddirectory.This will run the
run_realtime_algorithm.pyscript and save the output products at$PATH$/flarepred/RealTime/SessionSummaries/EXAMPLE_HISTORICAL_RUN2/(the number afterEXAMPLE_HISTORICAL_RUNmay vary). -
Run the following
python3 .../flarepred/RealTime/main_window.py
to use GUI under developement which has buttons to stop/start the GOES data plotting and a time display of REALTIME data. Output products are handled the same as in Example 1.
-
Run the following
python3 .../flarepred/RealTime/main_window.py historical
to view the GUI using historical data. This can be used to gain familiarity or for testing, etc.
See the RealTime module for a more detailed description on the workings of the package.
Remember to deactivate the Python virtual environment or just close the terminal being worked in.
If your local code needs updated because of a change on Github then git pull (or git pull origin main) should work.
If local changes have been made to the code that are not tracked or consistent with the newer version on Guthub then perform the following:
-
If you require the local changes to be saved somewhere before resetting, make sure to do the following, otherwise proceed to reset your local branch
git commit -a -m "local branch work"git branch local-work
-
To force your local coode to be what is on Github then
git fetch origingit reset --hard origin/main.
At the minute
-
The
main_window.pyGUI will only allow a launch when the automated trigger condition has been met (the status will change to "triggered" and the LED will flash yellow). -
If launched, the GUI must be run until the flare has stopped for the post-flare analysis process to be complteted succesfully.