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

add reader keywords to table in docs #360

Open
orbeckst opened this issue Jul 21, 2015 · 6 comments
Open

add reader keywords to table in docs #360

orbeckst opened this issue Jul 21, 2015 · 6 comments

Comments

@orbeckst
Copy link
Member

Add the format key words for Universe to the coordinate table in coordinates/init.py so that people know how to select e.g. the LAMMPS or the NAMD DCD reader #359

The keywords come from the dict coordinates._trajectory_readers.

@orbeckst
Copy link
Member Author

We should do the same for the topology readers and keyword topology_format.

@orbeckst
Copy link
Member Author

See also #431

@orbeckst orbeckst modified the milestones: 0.13, 0.13 bugfixes Jan 7, 2016
@richardjgowers
Copy link
Member

So I think this is referring to this table in the docs?

Now that #431 is done, there's no _trajectory_formats dict any more (or rather it's made dynamically).

I think it'd be best if we made a doc page along the lines of "Loading your stuff", which brought together the format options for both coordinates and topology (rather than it being in two modules hidden under our API spec :D)

@richardjgowers richardjgowers removed this from the 0.14 milestone Jan 20, 2016
@orbeckst
Copy link
Member Author

Am Jan 20, 2016 um 7:09 schrieb Richard Gowers [email protected]:

I think it'd be best if we made a doc page along the lines of "Loading your stuff", which brought together the format options for both coordinates and topology (rather than it being in two modules hidden under our API spec :D)

Yes, I agree. We should think about restructuring the docs into a user part (written with user view and interest in mind, can be reasonably short similar to what we cover in the tutorial) and the developer/API reference (from the doc strings). The formats would definitely go in the user part. @tylerjreddy, any thoughts?

@tylerjereddy
Copy link
Member

I don't think I've been following the custom readers / writers thing closely enough to fully understand the changes, so don't have any strong opinion here.

@orbeckst
Copy link
Member Author

@richardjgowers you're addressing #360 (comment) in PR #1827 – can we close this issue then?

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

No branches or pull requests

3 participants