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

Enhancement for paper: Refactor src, Write docs, Refactor package IO #34

Closed
zjwegert opened this issue Jan 24, 2024 · 4 comments · Fixed by #40
Closed

Enhancement for paper: Refactor src, Write docs, Refactor package IO #34

zjwegert opened this issue Jan 24, 2024 · 4 comments · Fixed by #40
Assignees
Labels
enhancement New feature or request

Comments

@zjwegert
Copy link
Owner

Rather minor but I think we could improve the file structure in src.

src/
   Optimisers/...
   Utilities.jl
   Advection.jl
   VelocityExtension.jl
   Solvers.jl
   ChainRules.jl (*)
   GridapExtensions.jl (**)
   PackageName.jl (***)

The main change to the above is moving MaterialInterpolation.jl and Benchmarks.jl into Utilities.jl.

Note
*: I think we could rename this to be more clear to people who don't typically use AD. @JordiManyer?
**: To be moved at some point
***: Need to decide name

@zjwegert zjwegert added the enhancement New feature or request label Jan 24, 2024
@JordiManyer
Copy link
Collaborator

*: In the end that file contains most of what we need to define the optimization problem itself, so I would probably choose a name that goes in that direction.

***: I would probably opt for either something Gridap-like (i.e GridapTopOpt.jl or similar) or something totally generic, like TopologyOptimization.jl (which is surprisingly free).

@zjwegert
Copy link
Owner Author

zjwegert commented Feb 1, 2024

*: We could go with PDEConstrainedFunctionals.jl or something. I'm not that keen on that name though...

***: OK here is a short list:

  • GridapTopOpt.jl
  • GridapLSTO.jl
  • LevelSetTopOpt.jl
  • TopologyOptimisation.jl or TopologyOptimisation.jl
    I'll have a think about it.

EDIT: I think I like LevelSetTopOpt.jl. It avoids "optimisation" where we have US/UK spelling issues with the z/s, and the level set aspect is important. I think GridapLSTO.jl is a close runner up but it isn't quite explicit enough I think.

@zjwegert zjwegert changed the title Enhancement for paper: Refactor src Enhancement for paper: Refactor src, Write docs Feb 4, 2024
@zjwegert zjwegert changed the title Enhancement for paper: Refactor src, Write docs Enhancement for paper: Refactor src, Write docs, Refactor package IO Feb 4, 2024
@zjwegert zjwegert pinned this issue Feb 4, 2024
@zjwegert
Copy link
Owner Author

zjwegert commented Feb 7, 2024

FYI @JordiManyer, I'm working on this in the src_refactor_and_docs branch. I'll make a PR to discuss once I've setup Documenter.jl.

@zjwegert zjwegert self-assigned this Feb 7, 2024
@JordiManyer JordiManyer linked a pull request Mar 12, 2024 that will close this issue
@zjwegert zjwegert reopened this Mar 12, 2024
@zjwegert
Copy link
Owner Author

Still on-going.

@zjwegert zjwegert closed this as completed Apr 7, 2024
@zjwegert zjwegert unpinned this issue Apr 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants