The source for the dart website is in the repo:
https://github.com/NCAR/dart-web
The readme contains instructions for running the website locally and adding new content.
Updating the publications page
Since there are hundreds of peer-reviewed journal articles that use DART, the workflow for updating the Publications page has been semi-automated. The workflow consists of three parts, which will be covered in detail below:
- Using citation management software to curate a list of publications that use DART
- Running a python script to format a data file output by the citation management software
- Committing the resulting file to the dart-web repository and pushing it to https://github.com/NCAR/dart-web
1. Using citation management software to curate a list of publications that use DART
Citation management software is typically used to organize and automate the process of creating a bibliography for a peer-reviewed publication or an academic work such as a thesis or dissertation. There are a few popular offerings of citation management software such as Mendeley, EndNote and Zotero. This example demonstrates how to manage the DART publications using Zotero.
Zotero consists of two components: a desktop application and a browser extension. The desktop application manages your local database of citations, while the browser extension makes it easy to add new citations to your local database. To get started, visit https://www.zotero.org/ to download the desktop application.
Once the application is installed, navigate to File → Import and upload the dart_publications.json file that is attached to this DIME article.
The json file should contain citations for all of the publications that use DART up until January 2024. After you have imported the json file, a collection named dart-publications should appear in your Zotero desktop application:
In order to add new publications to the collection visit https://www.zotero.org/download/connectors to install a browser extension:
Zotero offers browser extensions for the Google Chrome, Microsoft Edge, Apple Safari and Mozilla Firefox browsers.
A citation for a publication can be added to the DART publications collection by navigating to the landing page of the desired publication and clicking on the "Save to Zotero" icon that appears in the top-right corner of the browser window:
The new publication will be added to your local Zotero database. Note that the publication will be added to whichever collection is open in the navigation panel to the left of the desktop application, so you should have the dart-publications collection open.
When you are finished adding new publications, export the collection by right clicking on the collection name and selecting "Export Collection...".
Save the collection in CSL JSON file format:
2. Running a python script to format a data file output by the citation management software
Download the attached python script, json_to_markdown.py, and place it in the same directory as the the dart-publications.json file. The python script will read and format the publications contained in the json file to build the content of the publications page. Open a terminal window, change to the directory that contains the python script and the json file and run the python script:
python json_to_markdown.py
It will output a file named _index.md that should be moved to dart-web/content/publications/_index.md.
3. Committing the resulting file to the dart-web repository and pushing it to https://github.com/NCAR/dart-web
Once the newly created _index.md file has been moved to the the dart-web/content/publications/ directory, commit the changes and push them to the dart-web repository on Github.
Finding new publications that use DART
One technique for locating new publications that use DART is to use Google Scholar. Visit https://scholar.google.com/ and search for Anderson et al 2009 dart. The publication at the top of the search results should be the 2009 BAMS article that describes DART. If you click on the "Cited by" link, Google Scholar will return a list of publications that cite the 2009 BAMS article.
The returned list can be filtered by date by using the options in the navigation menu on the left side of the browser window:
If you click on one of the articles, you'll be taken to the landing page for that article on the publication's website. Make sure to read the article to ensure that the researchers actually used DART in their experiment's methodology before adding the article to the dart-publications list.
DART documentation
The DART documentation is hosted at readthedocs:
https://dart-documentation.readthedocs.io/
The 'latest' branch is built from convert_html_to_rst_install_sphinx
Note, the interface on readthedocs is a bit clunky. It is using the Github default branch as the stable version, no matter what is selected for the
default branch when you set up read the docs. For us, the default branch is Manhattan which does not have sphinx docs.
We may want a bot github account so readthedocs is not set up through a single person. Or, get ncar to host our sphinx documentation.
dart-publications.jsonjson_to_markdown.py