Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open FUSE todo #597

Open
28 of 43 tasks
orso82 opened this issue Jul 15, 2024 · 10 comments
Open
28 of 43 tasks

Open FUSE todo #597

orso82 opened this issue Jul 15, 2024 · 10 comments
Labels

Comments

@orso82
Copy link
Member

orso82 commented Jul 15, 2024

  • Register all packages with FuseRegistry @orso82

  • Consistent formatting for all packages @orso82

  • Add documentation build for all packages @orso82

  • Merge as many open PRs for the following repos

  • People should review NOTICE.md file of each package and change it as needed / wanted

  • What to do for packages developed under FPP-ID IR&D? @jacksonharvey @daveweisberg

    • XSteamTP
    • ThermalSystemModels --> to be made open
  • XSteam under PTP

  • Fix undocumented exported functions:

  • Fix regression tests

    • VacuumFields.jl
    • QED.jl
    • ThermalSystemModels.jl
    • ADAS.jl
  • (Ideally) Add runtests for the packages missing it

    • TEQUILA
  • Move generate_dd to it's own private repository

  • generate_dd as a CI service of IMASDD

  • Use FuseUtils instead of Trapz package in MXHEquilibrium @bclyons12

  • Update all github workflows to use FuseRegistry

  • Install FUSE from Manifest_CI.toml

  • Remove explicit dependency of sub-packages that resulted from using packages in dev mode

  • Bump most (all) packages versions to 1.x so that install from registry can pick up minor releases updates

  • Will likely need a make bump_versions branch=BLA that bumps minor versions of packages that have a branch matching a certain name. To be used when we merge a FUSE PR.

  • Finish writing paper

    • @TimSlendebroek to take most recent graphics and update what's on overleaf
    • To be submitted as Sherwood invited edition of PoP
  • Do all above for new repos:

    • RABBIT (what do we do with the executables?)
    • GenerateDD
  • Create FUSE discord server

  • Logging of actors should be turned on by default

========

  • try unpinning HDF5
@bclyons12
Copy link
Member

@orso82 Want to move up the code camp from next week to this week?

@orso82
Copy link
Member Author

orso82 commented Jul 15, 2024

Great suggestion @bclyons12 . Perhaps both weeks? Let me see if 13.301 is available this Wednesday (Thursday I am busy)

@bclyons12
Copy link
Member

Why do the documentation website have weird names, e.g., https://ideal-adventure-oz91nwl.pages.github.io/dev/

@orso82
Copy link
Member Author

orso82 commented Jul 15, 2024

because they are private. They'll get the normal naming once they are made pubic

@bclyons12
Copy link
Member

@orso82 I won't replace Trapz in MXHEquilibrium, since most of the integrals are 2D in that package, which FuseUtils does not handle (yet)

@orso82
Copy link
Member Author

orso82 commented Jul 16, 2024

Thank you for the clarification @bclyons12

@orso82
Copy link
Member Author

orso82 commented Jul 17, 2024

Current dependency tree of our packages

FUSE
├─ ADAS
├─ BoundaryPlasmaModels
│  ├─ ADAS
│  ├─ IMAS
│  │  ├─ CoordinateConventions
│  │  ├─ FXP
│  │  ├─ FuseUtils
│  │  ├─ IMASDD
│  │  └─ MillerExtendedHarmonic
│  ├─ IMASDD
│  ├─ MillerExtendedHarmonic
│  └─ SimulationParameters
├─ CHEASE
│  ├─ EFIT
│  │  └─ IMASDD
│  ├─ Fortran90Namelists
│  ├─ MXHEquilibrium
│  │  ├─ CoordinateConventions
│  │  ├─ EFIT
│  │  │  └─ IMASDD
│  │  ├─ MeshTools
│  │  └─ MillerExtendedHarmonic
│  └─ MillerExtendedHarmonic
├─ CoordinateConventions
├─ EPEDNN
├─ FXP
├─ FiniteElementHermite
├─ Fortran90Namelists
├─ FuseUtils
├─ FusionMaterials
│  └─ IMAS
│     ├─ CoordinateConventions
│     ├─ FXP
│     ├─ FuseUtils
│     ├─ IMASDD
│     └─ MillerExtendedHarmonic
├─ IMAS
│  ├─ CoordinateConventions
│  ├─ FXP
│  ├─ FuseUtils
│  ├─ IMASDD
│  └─ MillerExtendedHarmonic
├─ IMASDD
├─ MXHEquilibrium
│  ├─ CoordinateConventions
│  ├─ EFIT
│  │  └─ IMASDD
│  ├─ MeshTools
│  └─ MillerExtendedHarmonic
├─ MeshTools
├─ MillerExtendedHarmonic
├─ NEO
│  └─ IMAS
│     ├─ CoordinateConventions
│     ├─ FXP
│     ├─ FuseUtils
│     ├─ IMASDD
│     └─ MillerExtendedHarmonic
├─ NNeutronics
├─ QED
│  └─ FiniteElementHermite
├─ SimulationParameters
├─ TEQUILA
│  ├─ FiniteElementHermite
│  ├─ MXHEquilibrium
│  │  ├─ CoordinateConventions
│  │  ├─ EFIT
│  │  │  └─ IMASDD
│  │  ├─ MeshTools
│  │  └─ MillerExtendedHarmonic
│  └─ MillerExtendedHarmonic
├─ TGLFNN
│  └─ IMAS
│     ├─ CoordinateConventions
│     ├─ FXP
│     ├─ FuseUtils
│     ├─ IMASDD
│     └─ MillerExtendedHarmonic
├─ TJLF
├─ ThermalSystemModels
│  └─ XSteamTP
├─ VacuumFields
│  ├─ IMAS
│  │  ├─ CoordinateConventions
│  │  ├─ FXP
│  │  ├─ FuseUtils
│  │  ├─ IMASDD
│  │  └─ MillerExtendedHarmonic
│  ├─ MXHEquilibrium
│  │  ├─ CoordinateConventions
│  │  ├─ EFIT
│  │  │  └─ IMASDD
│  │  ├─ MeshTools
│  │  └─ MillerExtendedHarmonic
│  ├─ MillerExtendedHarmonic
│  └─ TEQUILA
│     ├─ FiniteElementHermite
│     ├─ MXHEquilibrium
│     │  ├─ CoordinateConventions
│     │  ├─ EFIT
│     │  │  └─ IMASDD
│     │  ├─ MeshTools
│     │  └─ MillerExtendedHarmonic
│     └─ MillerExtendedHarmonic
└─ XSteamTP

@bclyons12
Copy link
Member

@lstagner See https://probable-adventure-7k5llqw.pages.github.io/dev/api/ for exported MXHEquilibrium functions that are missing docstrings. Could you either add docstrings for those functions, or remove them from the exports if they are not to be used publicly by default?

@bclyons12
Copy link
Member

Ideas for updating package names to be General registry requirement

# need changing 
FUSE      # Fuse? or exception?
FXP        # FuseExchangeProtocol, FuseFXP
IMASDD     # IMASdd, FuseIMASDD
NEO        # FuseNeoclassical, FuseNEO
QED        # FuseCurrentDiffusion, FuseQED
TEQUILA    # FuseTequila, FuseTEQUILA
TGLFNN     # FuseTGLFNN, TGLFnn
TJLF       # FuseTJLF

# ask for exceptions based on established names
ADAS
CHEASE
IMAS

# no change needed
BoundaryPlasmaModels
CoordinateConventions
FiniteElementHermite
Fortran90Namelists
FuseUtils
FusionMaterials
MXHEquilibrium           # merge into Equilibrium?
MeshTools                # FuseMeshTools?
MillerExtendedHarmonic
NNeutronics              # maybe something more descriptive
SimulationParameters    
VacuumFields
ThermalSystemModels

@bclyons12
Copy link
Member

@orso82 ADAS tests are passing for me. Do you have an issue?

Conversely, TJLF tests are failing for me. Do they pass for you?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants