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

Changed theme to RTD and created quick start guide #11

Merged
merged 4 commits into from
Sep 22, 2019
Merged

Conversation

lilyminium
Copy link
Member

From #1 :

Story: As a molecular dynamics user, I want to set up MDAnalysis quickly and easily, so that I can move onto further analysis.

Story: As a molecular dynamics user, I want to convert my AMBER trajectory into a GROMACS format, so that I can use the GROMACS analysis tools on it.

Original plan

Sections:

  1. Link to page on installation.
  2. Load in a Universe.
  3. Writing out coordinates.
  4. Basic introduction to AtomGroups, ResidueGroups, SegmentGroups.
  5. Selecting atoms.
  6. Trajectories and positions.
  7. Universe persistence.
  8. Introduction to Analysis and modules.

Current structure:

  • Overview
  • Loading a structure or trajectory
  • Working with groups of atoms
    • Selecting atoms
    • Getting atom information from AtomGroups
    • AtomGroup positions and methods
  • Working with trajectories
    • Dynamic selection
  • Writing out coordinates
    • Single frame
    • Trajectories
  • Analysis
    • RMSD
  • References
    • Automatic citations with duecredit

While the general gist of the original plan is here, the actual structure is somewhat out the window. I struggled to place coordinate output early on without interrupting the flow. For users that see MDAnalysis as a way to convert trajectories, a nifty command-line tool might be better. Otherwise they can use the side bar to click directly to Writing out coordinates.

Acceptance criteria:

  • I know how to load in a coordinate file / simulation and write it out
    • almost immediately
  • I understand the arguments necessary to create ('set up') a Universe (kind of)
  • I understand basic atom selection
  • I understand basic analysis
  • I know how to write out coordinates.
  • I know where to look for less general knowledge (e.g. complex selection).
  • I have links to an index of examples, available analyses, and a tutorial for developing custom analyses.

@lilyminium
Copy link
Member Author

lilyminium commented Sep 9, 2019

Theme

I changed the theme from alabaster to readthedocs, modifying the CSS for sufficient orange. sphinx_rtd_theme is an additional extension. I also added nbsphinx earlier for pages that are also notebooks (the quick start guide, for example, is a notebook that users could download and work through.) Here's a screenshot of how it looks to me:

Screenshot 2019-09-09 at 10 53 34 PM

The orange links would benefit from being darker on that grey background, and suddenly the code highlighting clashes, but overall I find the collapsible menu with high contrast text/background colours to be more readable. Any thoughts?

P.S. Changing the User Guide part of the logo to the MDAnalysis font would be nice, if you know what it's called.

@lilyminium lilyminium mentioned this pull request Sep 9, 2019
7 tasks
@orbeckst
Copy link
Member

@beckstein what was the font that you used for the original MDAnalysis label?

@orbeckst
Copy link
Member

The new theme looks good. I do like the menu block. It's overall appearance is quite bold – I like it.

I also agree that collapsible menus are a massive improvement in navigability (if this is a word).

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the new theme.

I would suggest to remove a whole bunch of files from the commit (vscode, notebook checkpoints, example files, zip files, ...).

.vscode/settings.json Outdated Show resolved Hide resolved
doc/examples/analysis/pca.ipynb Show resolved Hide resolved
doc/examples/analysis/PCA_Tutorial.ipynb Outdated Show resolved Hide resolved
doc/source/_static/custom.css Show resolved Hide resolved
doc/source/auto_examples/index.rst Show resolved Hide resolved
@orbeckst
Copy link
Member

@lilyminium thanks for your patience, waiting for feedback. However, it's totally fine to ping me again if I haven't done anything for two days....

@lilyminium
Copy link
Member Author

I like the new theme.

I would suggest to remove a whole bunch of files from the commit (vscode, notebook checkpoints, example files, zip files, ...).

Oops, that's what I get for early-morning commits. The files in auto_examples are generated by sphinx_gallery to create the 'Examples' page of notebooks. The zips are a collection of all of them -- this a configurable option so we can turn it off.

Screenshot 2019-09-22 at 10 44 46 AM

@lilyminium
Copy link
Member Author

@lilyminium thanks for your patience, waiting for feedback. However, it's totally fine to ping me again if I haven't done anything for two days....

@orbeckst Yes, similar (sorry!) -- life has a way of getting in the way of my to-do list.

@lilyminium lilyminium merged commit 59844b3 into master Sep 22, 2019
@beckstein
Copy link

beckstein commented Sep 26, 2019 via email

@orbeckst
Copy link
Member

Thanks @beckstein !

@lilyminium lilyminium deleted the quickstart branch September 28, 2019 15:55
@orbeckst
Copy link
Member

@lilyminium the theme at https://www.mdanalysis.org/UserGuide/ looks really good.

I will vote for changing all our docs to your theme. I am pretty sure you'll hear similar sentiments from others, too, once they can experience the UserGuide layout and style for themselves.

We should then also to apply the altered color scheme to the webpage itself.

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

Successfully merging this pull request may close these issues.

3 participants