Skip to content

Commit 3bd3002

Browse files
authored
Merge branch 'MDAnalysis:master' into gsoc-intro
2 parents dc22900 + ffd1196 commit 3bd3002

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1177
-548
lines changed

Gemfile

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
source 'https://rubygems.org'
2-
ruby "~> 2.6"
2+
ruby ">= 2.7", "< 4"
33

4-
gem 'ffi', '=1.16.3'
54
gem 'github-pages'
65
gem 'rouge'
76
gem "webrick", "~> 1.7"
7+
8+
# rdiscount is a dependency of github-pages but earlier
9+
# version may trigger issue https://github.com/davidfstr/rdiscount/issues/145
10+
# (at least on macOS) so we explicitly pin here
11+
gem "rdiscount", ">= 2.2.0.2"
12+
13+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
14+
# and associated library; see https://jekyllrb.com/docs/installation/windows/
15+
platforms :mingw, :x64_mingw, :mswin, :jruby do
16+
gem "tzinfo", ">= 1", "< 3"
17+
gem "tzinfo-data"
18+
end

INSTALL.md

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Running Jekyll locally
2+
3+
Follow the [GitHub: Testing your GitHub Pages site locally with
4+
Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll) instructions
5+
6+
Two possible approaches: Either install `ruby` (>= 2.7) and
7+
[jekyll](https://jekyllrb.com/) locally or use a Docker image with a
8+
jekyll installation. The local ruby/jekyll is more flexible if you can
9+
get it to work.
10+
11+
## Local jekyll installation
12+
13+
Basically follow [GitHub: Testing your GitHub Pages site locally with
14+
Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll)
15+
and in particular [Jekyll's installation
16+
instructions](https://jekyllrb.com/docs/installation/).
17+
18+
19+
### macOS
20+
21+
Do not use the system ruby (i.e., not `/usr/bin/ruby`) but install
22+
your own version. The [Jekyll macOS
23+
instructions](https://jekyllrb.com/docs/installation/macos/) use
24+
[homebrew](https://brew.sh/) but this works equally well with
25+
[macports](https://www.macports.org/).
26+
27+
#### Overview
28+
29+
1. Use `chruby` and `ruby-install` to manage different ruby versions.
30+
2. Build ruby 3.4.1 (this was the recommended version in the Jekyll
31+
instructions at the time)
32+
3. Install all necessary gems from [Gemfile][] with `bundle`.
33+
34+
35+
#### ruby installation with macports
36+
37+
Install `chruby` and `ruby-install`: On macos with macports
38+
39+
sudo port install chruby ruby-install
40+
41+
Update `~/.bash_profile` (or your `~/.zshrc`) with
42+
43+
# chruby (macports)
44+
source /opt/local/share/chruby/chruby.sh
45+
46+
# To enable auto-switching of Rubies specified by .ruby-version files, add the
47+
# following to ~/.bash_profile or ~/.zshrc:
48+
source /opt/local/share/chruby/auto.sh
49+
50+
Install ruby (compile from source, this requires Xcode and development
51+
tools on macOS and will take a while):
52+
53+
ruby-install ruby 3.4.1
54+
55+
Switch to using it (can also be added to `~/.bash_profile`)
56+
57+
chruby ruby-3.4.1
58+
59+
To always activate this version, add a `.ruby-version` file in the
60+
directory with the `Gemfile` (see [How to install different versions
61+
of ruby and automatically switch between them](https://www.moncefbelyamani.com/how-to-install-xcode-homebrew-git-rvm-ruby-on-mac/#how-to-install-different-versions-of-ruby-and-switch-between-them)
62+
-- also needs chruby to be active):
63+
64+
echo "3.4.1" > .ruby-version
65+
66+
(May need to open a new terminal to let `.bash_profile` changes to take effect).
67+
68+
69+
### All OS: install gems (including jekyll)
70+
71+
Ensure that the correct version of ruby is use (`ruby --version`) and
72+
then
73+
74+
bundle install
75+
76+
should download and build the appropriate gems.
77+
78+
The `Gemfile.lock` should show something like
79+
```ruby
80+
GEM
81+
remote: https://rubygems.org/
82+
specs:
83+
...
84+
github-pages (232)
85+
github-pages-health-check (= 1.18.2)
86+
jekyll (= 3.10.0)
87+
...
88+
```
89+
90+
### Run jekyll locally
91+
92+
Start jekyll and have it serve the site at http://127.0.0.1:4000
93+
```bash
94+
rm -r _site
95+
bundle exec jekyll serve --watch --livereload --future --incremental
96+
```
97+
98+
(See the [serve commandline
99+
options](https://jekyllrb.com/docs/configuration/options/#serve-command-options)
100+
for more details.)
101+
102+
103+
104+
## Docker image
105+
106+
### macOS docker installation
107+
108+
- install Docker Desktop https://docs.docker.com/desktop/install/mac-install/
109+
- start docker
110+
- follow the solution from https://stackoverflow.com/a/58850151/ as
111+
described next
112+
113+
114+
### Build the site
115+
116+
To build the static site, run `jekyll build` inside docker:
117+
```bash
118+
export JEKYLL_VERSION=4.0
119+
docker run --rm \
120+
--volume="$PWD:/srv/jekyll" \
121+
-it jekyll/jekyll:$JEKYLL_VERSION \
122+
jekyll build
123+
```
124+
The static site files are stored in the `_site` directory.
125+
126+
### Serve the static site
127+
128+
Then you must *serve* the site:
129+
```bash
130+
cd _site
131+
python -m http.serve
132+
```
133+
134+
Point your browser to http://localhost:8000
135+
136+
When you make changes, you need to re-build the site.
137+
138+
139+

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ described next:
201201

202202
To **build the static site**, run `jekyll build` inside docker:
203203
```bash
204-
export JEKYLL_VERSION=3.8
204+
export JEKYLL_VERSION=4.0
205205
docker run --rm \
206206
--volume="$PWD:/srv/jekyll" \
207207
-it jekyll/jekyll:$JEKYLL_VERSION \
@@ -227,27 +227,28 @@ will appear on the web.*
227227
#### Build site locally ####
228228

229229
To run Jekyll in a way that matches the GitHub Pages build server, run `Jekyll`
230-
with `Bundler`. Use the command
230+
with `Bundler`. See [INSTALL](INSTALL.md) for notes on how to install Jekyll
231+
locally.
231232

232-
bundle exec jekyll serve
233+
Use the command
234+
235+
bundle exec jekyll serve --watch --livereload --future --incremental
233236

234237
in the root of your repository (after switching to the gh-pages branch for
235238
project repositories), and your site should be available at
236239
<http://localhost:4000>.
237240

238-
For a full list of Jekyll commands, see the [Jekyll
239-
documentation](https://jekyllrb.com/docs/).
241+
Running Jekyll locally has the advantage that you can have it update
242+
the site continuously while you're editing files.
240243

244+
(See the [serve commandline
245+
options](https://jekyllrb.com/docs/configuration/options/#serve-command-options)
246+
for more details.)
241247

242-
##### Advanced Jekyll usage #####
248+
For a full list of Jekyll commands, see the [Jekyll
249+
documentation](https://jekyllrb.com/docs/).
243250

244-
Running Jekyll locally has the advantage that you can have it update
245-
the site continuously while you're editing files:
246251

247-
bundle exec jekyll serve --livereload
248-
249-
In this way, the site is immediately rebuilt when you save changes to
250-
a file.
251252

252253

253254
##### Updating the github-pages plugin #####
@@ -261,6 +262,12 @@ with
261262

262263
##### Problems with jekyll and required packages? #####
263264

265+
* See [INSTALL](INSTALL.md) and if in doubt, follow the latest instructions from
266+
[GitHub: Testing your GitHub Pages site locally with
267+
Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll)
268+
and in particular [Jekyll's installation
269+
instructions](https://jekyllrb.com/docs/installation/)
270+
264271
* **Problems with installing jekyll/github-pages?** If the standard
265272
installation for jekyll does not work for you (many people complain,
266273
for instance, *commonmarker* does not install

_config.yml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ url: https://www.mdanalysis.org
2424
baseurl:
2525
author:
2626
name: The MDAnalysis Team
27-
url: https://twitter.com/mdanalysis
27+
url: https://www.mdanalysis.org/pages/team/
2828
2929

3030
images: /public/images
@@ -49,6 +49,11 @@ paginate: 3
4949
feed:
5050
path: atom.xml
5151

52+
# do not build these files/dirs:
53+
# see https://jekyllrb.com/docs/configuration/options/#global-configuration
54+
# (explicitly include the defaults for jekyll 3.x)
55+
exclude: [".sass-cache/", "gemfiles/", ".jekyll-cache/", "Gemfile", "Gemfile.lock", "README.md", "**/README.md", "INSTALL.md"]
56+
5257
# Custom vars
5358
version: 2.0.0
5459

@@ -63,6 +68,10 @@ pypi:
6368
package: https://pypi.org/project/MDAnalysis
6469
tests: https://pypi.org/project/MDAnalysisTests
6570
docs: https://docs.mdanalysis.org
71+
mdakits:
72+
registry: https://mdakits.mdanalysis.org/mdakits.html
73+
guide: https://mdakits.mdanalysis.org/makingakit.html
74+
issues: https://github.com/MDAnalysis/MDAKits/issues
6675
mailinglists:
6776
discussion:
6877
name: GitHub Discussions
@@ -76,6 +85,12 @@ mailinglists:
7685
twitter:
7786
name: mdanalysis
7887
url: https://twitter.com/mdanalysis
88+
linkedin:
89+
name: mdanalysis
90+
url: https://linkedin.com/company/mdanalysis
91+
bluesky:
92+
name: mdanalysis.bsky.social
93+
url: https://bsky.app/profile/mdanalysis.bsky.social
7994
discord:
8095
name: MDAnalysis
8196
url: https://discord.com/channels/807348386012987462/
@@ -90,6 +105,8 @@ docs:
90105
userguide:
91106
name: User Guide
92107
url: https://userguide.mdanalysis.org
108+
repo: https://github.com/MDAnalysis/UserGuide
109+
issues: https://github.com/MDAnalysis/UserGuide/issues
93110
quickstart:
94111
name: Quick Start Guide
95112
url: https://userguide.mdanalysis.org/stable/examples/quickstart.html
@@ -106,3 +123,4 @@ numfocus:
106123
sponsored_project: https://numfocus.org/project/mdanalysis
107124
donate_button: <a href="https://numfocus.org/donate-to-mdanalysis" target="_blank" style="background:#FF9200;padding:10px;margin:10px 0px;text-align:center;text-decoration:none;font-size:12pt;color:#000000;display:inline-block;border-radius:3px">Donate Now</a>
108125

126+

_data/team/roles/community_engagement.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
role: Community engagement
22
tasks:
3-
- Responding to questions on Discord and GitHub Discussions
4-
- Managing and triaging conversations on Discord and GitHub Discussions
3+
- Responding to questions on [Discord]({{ site.discord.url }}) and [GitHub Discussions]({{ site.mailinglists.discussion.url }})
4+
- Managing and triaging conversations on [Discord]({{ site.discord.url }}) and [GitHub Discussions]({{ site.mailinglists.discussion.url }})
5+
- General management and administration of social accounts (i.e., [LinkedIn]({{ site.linkedin.url}}), [Bluesky]({{ site.bluesky.url }})), [website]({{ site.url }}), and [blog]({{ site.blog }}), including...
6+
- *Posting announcements of new developments*
7+
- *Moderating content*
58

69
current_members:
710
- "[Brady Johnston](https://github.com/bradyajohnston)"

_data/team/roles/core_library_maintenance.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ subroles:
3333

3434
- subrole: General maintenance
3535
tasks:
36-
- Monitoring and acting on maintenance needs across the MDAnalysis ecosystem
37-
- Standards compliance (e.g. managing metadata such as the author list)
36+
- Monitoring maintenance needs across the MDAnalysis ecosystem
37+
- Acting on maintenance needs, or delegating to appropriate managers of sub-projects, as necessary
38+
- Standards compliance (e.g., managing metadata such as the author list)
3839
- Tracking new dependencies
3940
- Emergency fixes
4041
- Other general maintenance tasks

_data/team/roles/documentation.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ current_members:
1111
- "[Egor Marin](https://github.com/marinegor)"
1212
- "[Irfan Alibay](https://github.com/IAlibay)"
1313
- "[Lily Wang](https://github.com/lilyminium)"
14+
- "[Micaela Matta](https://github.com/micaela-matta)"
15+
- "[Namir Oues](https://github.com/namiroues) (technical writer)"
16+
- "[Oliver Beckstein](https://github.com/orbeckst)"
1417
- "[Rocco Meli](https://github.com/RMeli)"
15-
16-
18+

_data/team/roles/external_liaison.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,7 @@ tasks:
66

77
current_members:
88
- "[Irfan Alibay](https://github.com/IAlibay)"
9-
- "[Oliver Beckstein](https://github.com/orbeckst)"
109
- "[Jenna Swarthout Goddard](https://github.com/jennaswa)"
10+
- "[Micaela Matta](https://github.com/micaela-matta)"
11+
- "[Oliver Beckstein](https://github.com/orbeckst)"
12+
- "[Yuxuan Zhuang](https://github.com/yuxuanzhuang)"

_data/team/roles/mdakit_registry.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ tasks:
33
- Managing submissions to MDAKits registry
44
- Managing manual review process of new MDAKits
55
- Managing automated test and badge infrastructure of all MDAKits
6-
- Manage helping with MDAKits who need assistance
6+
- Offer input on failures due to the MDAKit registry
77
current_members:
88
- "[Irfan Alibay](https://github.com/IAlibay)"
99
- "[Fiona Naughton](https://github.com/fiona-naughton)"

_data/team/roles/outreach.yml

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,18 @@ role: Outreach
22
subroles:
33
- subrole: Workshops and meetings
44
tasks:
5-
- Identifying workshop and event opportunities
5+
- Identifying workshop and event opportunities and sponsors
66
- Organising workshops and events
77
- Gathering and coordinating volunteers
88
- Managing content, presentations and teaching at workshops
9+
- Managing teaching materials on GitHub for workshops and events
10+
- Maintaining and fixing materials
911
current_members:
1012
- "[Brady Johnston](https://github.com/bradyajohnston)"
1113
- "[Jenna Swarthout Goddard](https://github.com/jennaswa)"
1214
- "[Micaela Matta](https://github.com/micaela-matta)"
15+
- "[Rocco Meli](https://github.com/RMeli)"
16+
- "[Yuxuan Zhuang](https://github.com/yuxuanzhuang)"
1317

1418
- subrole: Mentoring programs
1519
tasks:
@@ -21,12 +25,3 @@ subroles:
2125
- "[Egor Marin](https://github.com/marinegor)"
2226
- "[Jenna Swarthout Goddard](https://github.com/jennaswa)"
2327
- "[Google Summer of Code (GSoC) mentors](https://github.com/MDAnalysis/mdanalysis/wiki/Google-Summer-Of-Code#available-mentors)"
24-
25-
- subrole: Teaching materials
26-
tasks:
27-
- Managing teaching materials on GitHub for workshops and events
28-
- Maintaining and fixing materials
29-
current_members:
30-
- "[Rocco Meli](https://github.com/RMeli)"
31-
- "[Micaela Matta](https://github.com/micaela-matta)"
32-
- "[Jenna Swarthout Goddard](https://github.com/jennaswa)"

0 commit comments

Comments
 (0)