GithubHelp home page GithubHelp logo

Comments (4)

ToruNiina avatar ToruNiina commented on June 8, 2024

Also for the input file spec:
Mjolnir allows to split an input file to several toml files to avoid too long input file. Currently, adding table name to the splitted input file is discouraged.

# input.toml
[[systems]]
file_name = "system1.toml"

The above input file requires a toml file like the following.

# system1.toml
# [system] <- currently discouraged because 
#             it is already clear that
#             this file is dedicated to a system.
particles = [
# ...
]

But now I think it is better to have a tabl in the splitted input files to show explicitly what does the file define. Of course one can guess what is defined in the file because each table requires different values, but it takes time to understand what is the content (and also requires knowledge about the input file). With a table name, we can easily see what is defined in the file. Users will be enforced to write the information explicitly in the file by requiring table, but I think it is better than to write comments manually.

So, here I propose changing the requirements for the splitted input files. It also introduce an extra complexity to read_* because the current implementation also allows to define a table. To simplify the code, we also need to decide the way to split an input file.

The splitted input files correspond to one element of arrays of tables, [[systems]], [[forcefields]] or something like that, so it is good to require a table for each file (e.g. [system] for a file that defines an element of [[systems]]).

from mjolnir.

ToruNiina avatar ToruNiina commented on June 8, 2024

ExcludedVolumePotential that is used with a global interaction requires radius for all the particles. But ExcludedVolumeWallPotential that is used with an external interaction (it acts as a wall!) requires sigma.

It should be fixed. I think radius is better because it's clearer.

from mjolnir.

ToruNiina avatar ToruNiina commented on June 8, 2024

Finally I found that it is not clear to use different name and data type for the same table defined in a different file (like, [forcefield.global] for an individual file and [[forcefields.global]] in a separated file).

For now, I decided to use the same name, [[systems]] and [[forcefields.global]] for separated input files.

from mjolnir.

ToruNiina avatar ToruNiina commented on June 8, 2024

done.

from mjolnir.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.