cxcsds / ciao-contrib

Extra scripts and code to enhance the capabilities of CIAO.
GNU General Public License v3.0
8 stars 6 forks source link

This update includes two bug fixes and a few improvements to notebook… #878

Closed dprincipe2 closed 1 month ago

dprincipe2 commented 4 months ago

…_plotter and its associated tutorial notebook.

Bug fixes:

-Fixed a bug where notebook_plotter doesn't update plotted values with widget interactions when plotting a model that is not properly assigned (via set_source) to the loaded dataset.

-Fixed a bug when plot_type was 'both models' that plotted incorrect values for the y-axis of the convolved model. The correct values are now displayed.

Features added:

-A new dataset_id parameter allows users to choose any of their loaded datasets and models to plot with notebook_plotter.

-Several checks have been introduced to ensure notebook_plotter is showing accurate information. If users try to do something that is not allowed they are warned and provided a suggestion for getting around the error.

-Added an example section to the function help text and increased clarity in several parameter descriptions.

-Modified some of the examples in the notebook tutorial to account for the new features and bug fixes to notebook_plotter.

dprincipe2 commented 4 months ago

Hi @DougBurke and @hamogu,

This update should fix the remaining issues with notebook_plotter. If anyone tries it out and finds any other issues please let me know!

@DougBurke, I saw the below instructions online for running the notebook but i don't see the .ipynb file anywhere. In my new CIAO installation, I don't have an $ASCDS_INSTALL/share/sherpa directory. Is there a typo somewhere?

unix% mkdir notebooks unix% cp $ASCDS_INSTALL/share/sherpa/notebooks/*ipynb notebooks/ unix% jupyter lab --notebook-dir notebooks

kglotfelty commented 1 month ago

@dprincipe2

Sorry, I'm not sure how to do this on your branch, but can you can you modify ciao-contrib/mk_script_tarfile

% git diff mk_script_tarfile 
diff --git a/mk_script_tarfile b/mk_script_tarfile
index 4556258..9edd204 100755
--- a/mk_script_tarfile
+++ b/mk_script_tarfile
@@ -52,7 +52,7 @@ def build_dist(version, dirname, outdir, python="python3.10"):

     # Copy directories over to this directory
     #
-    for basedir in ["bin", "share/doc/xml", "share/xspec/install", "data", "config", "param"]:
+    for basedir in ["bin", "share/doc/xml", "share/xspec/install", "share/sherpa/notebooks", "data", "config", "param"]:
         newdir = outdir / basedir
         newdir.mkdir(parents=True)
         nfiles = 0

basically we need to add the share/sherpa/notebooks into the list of dirs that gets put into the tarfile we pass off to DS.

dprincipe2 commented 1 month ago

Ok, the change to mk_script_tarfile should be in there now.