Skip to content

Commit

Permalink
adding initial dump of files, still need to add tests, automated buil…
Browse files Browse the repository at this point in the history
…ds, etc.

Signed-off-by: vsoch <[email protected]>
  • Loading branch information
vsoch committed Feb 16, 2020
0 parents commit 325d6ec
Show file tree
Hide file tree
Showing 47 changed files with 12,173 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Gemfile.lock
_site
8 changes: 8 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
source 'https://rubygems.org'

gem "github-pages", '193', group: :jekyll_plugins

# enable tzinfo-data for local build
# gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw]
gem 'jekyll-paginate'
gem 'faraday', '0.15.4'
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# The US-RSE Map

This repository contains static files and workflows to generate the US-RSE map.

## 1. How does it work?

The map locations are derived from the US-RSE official roster, meaning
that the institutions or companies are exported, and associated
with a location that can be found in the [locations lookup](_data/location-lookup.tsv).
While the final locations and counts are written to the [locations data](_data/locations.csv)
file, **you should not manually update this file** as it is done by a script (see below).
The idea behind using a lookup is that (over time) most locations will be represented,
and so new members to USRSE will simply use these same locations and we'll update the counts
with the GitHub workflow.

### 2. How do I update the map?

You don't! The automated workflow does. The workflow under [.github/workflows/update-map.yml](.github/workflows/update-map.yml)
handles this for you. To add yourself (if you haven't yet) you can fill out the
institution field under the [join form](https://docs.google.com/forms/d/e/1FAIpQLSdJbPczGHFN8mfMFu_YQym508OzFtOZxfSzr1sOoINxaMmiaw/viewform).


### 3. How do update locations?

The [locations lookup](_data/location-lookup.tsv) is what we update with new institutions.
Basically, it's a lookup of institution name (represented in the roster) and matching
city and state. While the workflow is set up to run this check, you can also do so manually.

```bash
python script/update_lookup.py
```

Whether you run it manually or see a message in a pull request, when you add a location
to the [locations lookup](_data/location-lookup.tsv) you should:

- ensure that it remains TAB delimited
- add the location in the correct alphabetical order
- ensure that the city and state added have a zip code that is locatable (the test will determine this)
- write the institution (or other name) in alphabetical order
- the institution must appear as an entry in the actual data export from the form

If you find an institution that doesn't have a location (e.g., it's virtual, or general US) then write in "remote"
for the location.

### 3. How do we run tests?

Tests are run in a separate workflow at [.github/workflows/main.yml](.github/workflows/main.yml).
Since a contribution will come down to updating the list of locations in the lookup,
we ensure that:

1. They are all in lowercase
2. They are actually represented in the form data export
3. The city/state combinations can be looked up
4. Locations are sorted in alphabetical order
5. The file can be read and is TAB delimited.

<!--- ## Join us! --->

<a href="https://docs.google.com/forms/d/e/1FAIpQLScBQ6AYpYYK2wL21egcaVvH0ZEvtShU-0s-XbqnY3okUsyIZw/viewform">
<img width="250px" alt="signup button" src="assets/img/signup.png"></a>
106 changes: 106 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# --- General options --- #

# url is the full website URL
# baseurl is the website's URL without the hostname
# DO NOT CHANGE THE LINE NUMBERS HERE without changing .circleci/circle_urls.sh
# If you are building a simple GitHub user page (https://username.github.io) then use these settings:
url: "https://us-rse.org"
baseurl: "/usrse-map" # for testing, also check .circleci/circle_urls.sh
title-img: /assets/img/rse_logo_background.svg # baseurl will be prepended
twitter-img: /assets/img/logo_600px.png # url + baseurl will be prepended
mapbox: "pk.eyJ1IjoidnNvY2giLCJhIjoiY2sxdXE4dGZ6MGxveTNibzBqc2E5OXpzbiJ9.OdVyKYmHLhSsk03iQoN1kw"

# Name of website
title: US-RSE Association

# Short description of your site
description: US Research Software Engineer Association Map

# --- Navigation bar options --- #

# Image to show in the navigation bar - image must be a square (width = height)
# Remove this parameter if you don't want an image in the navbar
avatar: "/assets/img/avatar-icon.png"

# List of links in the navigation bar
navbar-links:
Home: "https://us-rse.org"

# --- Background colour/image options --- #

# Personalize the colors in your website. Colour values can be any valid CSS colour

navbar-col: "#F5F5F5"
navbar-text-col: "#ffffff"
navbar-children-col: "#500e3d"
page-col: "#FFFFFF"
link-col: "#008AFF"
hover-col: "#0085A1"
footer-col: "#F5F5F5"
footer-text-col: "#777777"
footer-link-col: "#404040"

# Alternatively, the navbar, footer, and page background can be set to use background images
# instead of colour

navbar-img: "../img/rse-transport-light.png"
# footer-img: "../img/rse-transport-light.png"
# page-img: "/img/bgimage.png"

# --- Footer options --- #

# Change all these values or delete the ones you don't want.
# Important: you must keep the "name" parameter, everything else you can remove
author:
name: US-RSE

# Social Network Links
social-network-links:
github: USRSE
twitter: us_rse

# Select which share links to show in posts
share-links-active:
twitter: true
facebook: false
google: false
linkedin: false

# How to display the link to the website in the footer
# Remove this if you don't want a link in the footer
url-pretty: "us-rse.org"

# Fill in your Google Analytics ID to track your website using GA
google_analytics: "UA-133428825-1"

# Output options (more information on Jekyll's site)
timezone: "America/New_York"
markdown: kramdown
highlighter: rouge
permalink: /:year-:month-:day-:title/

kramdown:
input: GFM

# Default YAML values (more information on Jekyll's site)
defaults:
-
scope:
path: "" # all files
values:
layout: "page"
show-avatar: false
css: /assets/css/custom.css

# Use tags index page and make tags on each post clickable
link-tags: true

# Exclude these files from production site
exclude:
- _site
- Gemfile
- Gemfile.lock
- LICENSE
- README.md
- tests
- vendor
106 changes: 106 additions & 0 deletions _data/location-lookup.tsv
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
name city-state
academic data science alliance remote
amazon Seattle, WA
applied materials inc Santa Clara, CA
argonne national laboratory Lemont, IL
arizona state university Phoenix, AZ
australian research data commons Caulfield East VIC 3145 Australia
baylor college of medicine Houston, TX
boise state university Boise, ID
brown university Providence, RI
caltech Pasadena, California
cfd research corporation Huntsville, AL
chapman university Orange, CA
clemson university Clemson, SC
cleveland clinic Cleveland , Ohio
columbia university New York City, NY
dartmouth college Dartmouth, NH
dftworks llc Oakton, VA
george washington university Washington, DC
georgetown university Washington, DC
georgia tech Atlanta, GA
harvard t.h. chan school of public health Boston, MA
harvard university Cambridge, MA
haverford college Haverford, PA
ibm Armonk, NY
imperial college london South Kensington, London SW7 2BU, United Kingdom
indian institute of technology kanpur Kalyanpur, Kanpur, Uttar Pradesh 208016, India
indiana university Bloomington, IN
inria Domaine de Voluceau, 78150 Rocquencourt, France
insurtechnix Burnham House, Splash Ln, Wyton, Huntingdon PE28 2AF, United Kingdom
intellectual ventures Bellevue, WA
internet2 Washington, DC
iris passcal new mexico institute of mining and technology Socorro, NM
kitware Clifton Park, NY
lanl Los Alamos, NM
lawrence berkeley national laboratory Berkeley, CA
lawrence livermore national lab Livermore, CA
lewis & clark college Portland, OR
llnsâ\x80¯llc remote
los alamos national laboratory Los Alamos, NM
michigan state university East Lansing, MI
microsoft Redmond, WA
national center for atmospheric research Boulder, CO
national center for supercomputing applications Urbana, IL
national institutes of health Bethesda, MD
national renewable energy laboratory Golden, CO
nbc news New York City, NY
ncar Boulder, CO
new york university New York, NY
northwestern university Evanston, IL
nvidia Santa Clara, CA
oak ridge national laboratory Oak Ridge, TN
penn state State College, PA
pennsylvania state university pennsylvania state university
perimeter institute for theoretical physics Waterloo, Ontario, Canada, N2L 2Y5
princeton university Princeton, NJ
purple workshops remote
rand corporation Santa Monica, CA
sandia natioal laboratories Albuquerque, NM
sandia national laboratories Albuquerque, NM
self employed remote
smithsonian astrophysical observatory Cambridge, MA
southern methodist university Dallas, TX
stanford Stanford, CA
stanford graduate school of business Stanford, CA
stanford university Stanford, CA
syf nepal Kathmandu 44600, Nepal
temple university Philadelphia, PA
the georgia institute of technology Atlanta, GA
the hospital for sick children Toronto, ON Canada
the molecular sciences software institute Blacksburg, VA
the pennsylvania state university State College, PA
the research software company remote
the university of texas at austin Austin, TX
the university of washington Seattle, WA
u.s. epa & unc chapel hill Chapel Hill, NC
ucla Los Angeles, CA
uiuc Champaign, IL
university at buffalo Buffalo, NY
university of central florida Orlando, FL
university of chicago Chicago, IL
university of colorado boulder Boulder, CO
university of delaware Newark, DE
university of florida Gainesville, FL
university of illinois at urbana-champaign Champaign, IL
university of illinois, vocable communications, llc Champaign, IL
university of iowa Iowa City, IA
university of kentucky Lexington, KY
university of maryland, college park College Park, MD
university of massachusetts Amherst, MA
university of memphis Memphis, TN
university of michigan Ann Arbor, MI
university of minnesota Minneapolis, MN
university of notre dame Notre Dame, IN
university of pittsburgh Pittsburgh, PA
university of reading Reading, United Kingdom
university of texas at austin Austin, TX
university of texas at san antonio San Antonio, TX
university of virginia Charlottesville, VA
university of washington Seattle, WA
university of wyoming Laramie, WY
usda-forest products laboratory Madison, WI
uw madison Madison, WI
vanderbilt university Nashville, TN
western university Gunnison, CO
yale university New Haven, CT
Loading

0 comments on commit 325d6ec

Please sign in to comment.