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

Full Input File Customization #4

Open
kombatEldridge opened this issue Dec 17, 2024 · 0 comments
Open

Full Input File Customization #4

kombatEldridge opened this issue Dec 17, 2024 · 0 comments

Comments

@kombatEldridge
Copy link
Owner

kombatEldridge commented Dec 17, 2024

A fully customizable input file will have several features:

  1. A few parameters are documented as necessary. PlasMol will error out if these parameters are missing.
  2. A majority of parameters can be absent from the input file and should default in the code itself. The defaults should be posted in documentation.
  3. A few parameters exist in pairs where only one is necessary and inherently sets the value for the other (i.e. wavelength and frequency). An error should be thrown if both of these are given.
  4. Mid line comments should be accepted.
start simulation
    resolution 2000 -- this is a comment, but the resolution should still be read
end simulation
  1. Simple math should be supported for numeric parameters.
start simulation
    resolution 4000/2 -- should return 2000 
end simulation
  1. Each source type supported by Meep should be supported by PlasMol.
  2. Each object geometry supported by Meep should be supported by PlasMol.
  3. All parameters should be appropriately named. For parameters with two or more words in their name, they should either all be of the form source_type or sourceType.
  4. The driver.py should not have the input file hard coded unless absolutely necessary.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant