Skip to content

todo.md

Latest commit

 

History

History
124 lines (114 loc) · 7.3 KB

todo.md

File metadata and controls

124 lines (114 loc) · 7.3 KB
Raw

General TODO:

Primary TODO:

  • I/O:

    • Add option to guess the charge with RDKit if not set
    • Add support for writing complex trees to ASE (currently only stackable trees supported)

  • Tree improvement

    • Tree function wrappers with tree parameters for non-tree parameters in unwrapped function
    • Renaming/restructuring support of tree structure
    • Selection functions on the tree (compound=?, group=?, <grouping_param>=?)
      • Added stubs for .sel() and .isel()
      • Add implementation capturing appropriate dimensions/indexes.
      • Propagate remaining indexers to data entries.
    • Pattern matching in the getitem() method, i.e. db['/I01/**/data'] db["/I01/*/{1-20}"]
    • TODO: FIXME: typing.get_origin() does not work on TreeNode specializations. Maybe just patch the base class in _create_extended_node_class?
    • TODO: Add backup visualization probably with networkx to circumvent issue with html repr not working on github. (See TODO: note in TreeNode class after _repr_html())
    • Implement parallel/delayed execution of maps on tree

  • (De)serialization:

    • Implementation of Supports(To/From)XrConversion for various (wrapper) types
    • Tutorial on how to add own types
    • Improve import performance of tree. Currently incredibly slow due to issues with how h5netcdf resolves variable names, which causes the input file to be parsed again (apprently?). Import spends 90% of time in name resolution for variables.

  • Wrapper types:

    • Add supported Shnitsel-tools functions as direct methods on wrapper types
    • Improve Visualization/helper text
    • Add DataArray wrapper
      • Add specifically an AtXYZ/Positions Wrapper type.
    • Add more wrapper types for support function returns
    • TODO: Make trajectory select the desired entries in Stacked sets (should select for both atrajectory and trajectory)
    • TODO: Make trajectory drop the NaN frames in result for Layered sets.

  • StructureSelection

    • Options in function signatures (provide directly a SMARTs string, deal with trees, etc.)
      • On-the-go construction added to geo._get_default_selection()
      • Patch existing functions to express support for descriptors
    • Add merge/subtract/intersect operations
    • Add 'BLA' and 'pwdist' feature descriptors.
    • Fix non-redundant coordinates
    • Structure selection (raise error if empty/warning if empty)
    • draw: Draw grid of highlighted feature levels
    • draw: Use highlight_features function

  • Profiling of key functions like get_bats()

    • Drastically improved performance of get_bats() and other geocalc functions by employing multi-.sel() feature of xarray we originally had used before the rewrite.

  • Analogs tree, structure selection, warning if no match for compounds

    • Adapted to tree support
    • Add intermediate result of extracted matches and visualization
    • Make punch-out work on structure selection objects? We can allow provision of structure selections with atoms selected and then those will be punched out an relabeled?
    • Copy if multiple matches
    • For now: ignore if multiple matches

  • StateSelection

    • Add Support for textual representation of state selection
    • Add merge/subtract/intersect operations

  • biplot_kde needs to be fixed to use the descriptors of the PCA in the side plots.

    • Fix PCA loadings main contribution plot not being the same as the explained PCA.
    • Fix cluster loadings plot occasionally empty.
    • Add a state coloring option to explore splits between different states in state space
    • Add 'feature_extractor' to dimensionality reduction wrapper and allow for datasets to be provided to the project call
    • Retain settings of feature extractor like get_bats in bats object and the dimensionality reduction wrapper. (i.e. the settings with which bats were calculated.)

  • Visualization support

    • Add generic plot() function to various types
    • Add option for plots from tree hierarchies
    • Refactor the spectra plots
      • Make spectra plots work with wrapper types/datasets
      • TODO: Make spectra plots work with trees.
    • Refactor colored PCA line plots
    • Refactor time plots
    • Refactor

  • Add tutorial for further CLI tools

  • Dimension reduction:

    • Refactor PLS
    • Refactor LDA
    • Make projection onto PCA/other lower dimension return an appropriate wrapper format (e.g. PCAResult)

  • Clustering support

    • DBSCAN sounds like a good option to support

  • Datasheet

    • Improve documentation
      • Refactor documentation
      • Make docstrings more detailed
    • DatasheetPage:
      • Improve PCA Page (finished)
      • Improve default settings for datasheet and pages.
      • Add page for spectral analysis

  • Hops

    • Fix some functions not yet moved to tree types or new style of type selection.
      • assign_hop_time() done
      • focus_hops()
      • PLS
      • LDA
      • TICA
      • Test restored hop functions
      • Test new dimred functions

  • CLI tutorial

  • Full tutorial retinal

    • Retinal BLA/HOOP/Dihedrals (Put all dihedrals in), 3->2 Dimension reduction
    • Retinal PCA biplot to show we can find the right parameters
    • Length threshold statistics plot
    • Datasheet (note, that generation takes somewhat longer)
    • add one more cool plot, the hop-time alignment would be perfect

  • st accessors

    • Fix union types not being unwrapped in generator
    • FQTN types not being passed as TypeForms/string for types not explicitly imported.
    • Replace type vars by their bounds or Any.
    • TODO: FIXME: Generic Parameters get lost in generation.

Secondary TODO:

  • Add tests for conversion

  • Mask array to only consider relevant data. Would allow us to limit atom, timestep, etc. Should probably be generated at loading time and not really stored.

  • Make it possible to merge a trajectory into an already multi-trajectory. May be necessary for some users or for us extending datasets in the future.

  • Do NewtonX/PyrAI2md have charge information? SHARC 4.0 has charge info. -> Not that we know of. Probably hidden in QM interface.

  • Add command line tools for annotation and inspection of trajectories/netcdf files

  • Add tox for testing shnitsel with different python versions

Tertiary TODO:

  • FIXME: Shape mismatch between DCM in PyRAI2md and default trajectory setup
  • Support reading SHARC netcdf output files

Profiling notes:

python -m cProfile ./shnitsel/cli/convert_to_shnitsel.py tutorials/test_data/sharc/iconds_butene/ -o tutorials/test_data/playground/iconds_butene.nc -c butene -est bravo -basis gulasch -log debug > tutorials/test_data/playground/iconds_butene.profile.log python -m cProfile ./shnitsel/cli/convert_to_shnitsel.py tutorials/test_data/playground/C02_sc-mCy_C4N2H9/init -o tutorials/test_data/playground/C02_sc-mCy_C4N2H9.nc -c C02 -est bravo -basis gulasch -log debug > tutorials/test_data/playground/C02.profile.log python -m cProfile ./shnitsel/cli/convert_to_shnitsel.py tutorials/test_data/playground/C01_sc-Cy_C3N2H7/init -o tutorials/test_data/playground/C01_sc-Cy_C3N2H7.nc -c C01 -est bravo -basis gulasch -log debug > tutorials/test_data/playground/C02.profile.log