|
1 | | -# Open Science for Librarians |
| 1 | +# Lessons for Librarians in Open Science Principles and Methods |
2 | 2 |
|
3 | 3 | [](https://doi.org/10.5281/zenodo.18055759) |
| 4 | +[](https://ucla-imls-open-sci.info) |
| 5 | +[](https://creativecommons.org/licenses/by/4.0/) |
| 6 | +[](https://www.tidyverse.org/lifecycle/#stable) |
| 7 | +[](https://en.wikipedia.org/wiki/English_language) |
4 | 8 |
|
5 | | -This is the official website for the "Lessons for Librarians in Open Science Principles and Methods" project, funded by the Institute of Museum and Library Services (IMLS). |
| 9 | +## Description |
6 | 10 |
|
7 | | -## Project Overview |
| 11 | +This project provides a comprehensive, open-source curriculum hub for librarians covering Open Science principles, data management, and reproducibility. The curriculum consists of 14 peer-reviewed open science lesson plans developed through an Institute of Museum and Library Services (IMLS) funded initiative. |
8 | 12 |
|
9 | | -This site serves as a curriculum hub for librarians, providing access to: |
10 | | -* Peer-reviewed open science lesson plans. |
11 | | -* Instructor guides and resources. |
12 | | -* Profiles of the lesson authors and contributors. |
13 | | -* Foundational open science frameworks and references. |
| 13 | +**Target Audience:** Librarians at any career stage seeking to increase their aptitudes in the principles and practices of Open Science. |
14 | 14 |
|
15 | | -## Call for Pilots |
| 15 | +**Learning Outcomes:** Upon completion of these lessons, learners will be able to: |
| 16 | +- Apply open science principles and methods in library instruction and research support |
| 17 | +- Effectively collaborate with faculty and researchers on science projects using open science practices |
| 18 | +- Provide instruction to new researchers on data management, reproducibility, and open research workflows |
| 19 | +- Utilize modern tools and technologies for open and reproducible research |
16 | 20 |
|
17 | | -We are currently looking for community members to pilot these lessons. If you are interested in teaching or field-testing any of these materials, please [open an issue on our Pilot Interest tracker](https://github.com/ucla-imls-open-sci/ucla-imls-open-sci.github.io/issues/new?template=pilot-interest.yml). |
| 21 | +## Rendered Lesson Website |
18 | 22 |
|
19 | | -## Tech Stack |
| 23 | +The complete curriculum and lesson materials are available at: **[https://ucla-imls-open-sci.info](https://ucla-imls-open-sci.info)** |
20 | 24 |
|
21 | | -This site has been migrated from Jekyll to **Astro** (v5). It uses: |
22 | | -* **Framework**: Astro |
23 | | -* **Styling**: SCSS (Bootstrap-based Agency theme) |
24 | | -* **Content**: YAML data files and Markdown |
25 | | -* **Deployment**: GitHub Actions -> GitHub Pages |
| 25 | +## Contact Information |
26 | 26 |
|
27 | | -## Development |
| 27 | +For questions, feedback, or collaboration inquiries, please contact: |
28 | 28 |
|
29 | | -### Prerequisites |
30 | | -* Node.js (v18 or higher recommended) |
31 | | -* npm |
| 29 | +- **Tim Dennis ** (Program Director) - [[email protected]](mailto:[email protected]) | [ORCID: 0000-0001-6632-3812 ](https://orcid.org/0000-0001-6632-3812) |
| 30 | +- **Zhiyuan Yao** (Program Coordinator) - [ORCID: 0000-0002-7601-8704](https://orcid.org/0000-0002-7601-8704) |
32 | 31 |
|
33 | | -### Quick Start |
| 32 | +You can also: |
| 33 | +- Open an issue on our [GitHub repository](https://github.com/ucla-imls-open-sci/ucla-imls-open-sci.github.io/issues) |
| 34 | +- Indicate interest in piloting a lesson using our [Pilot Interest tracker](https://github.com/ucla-imls-open-sci/ucla-imls-open-sci.github.io/issues/new?template=pilot-interest.yml) |
34 | 35 |
|
35 | | -1. Install dependencies: |
36 | | - ```bash |
37 | | - npm install |
38 | | - ``` |
| 36 | +## Contributing |
39 | 37 |
|
40 | | -2. Start the local development server: |
41 | | - ```bash |
42 | | - npm run dev |
43 | | - ``` |
44 | | - Access the site at http://localhost:4321. |
| 38 | +We welcome contributions from the community! We are especially interested in: |
45 | 39 |
|
46 | | -3. Build for production: |
47 | | - ```bash |
48 | | - npm run build |
49 | | - ``` |
50 | | - The output will be generated in the `dist/` directory. |
| 40 | +- **Lesson Pilots**: Community members interested in teaching or field-testing these materials |
| 41 | +- **Feedback and Improvements**: Suggestions for enhancing lesson content, clarity, and accessibility |
| 42 | +- **Bug Reports**: Identification of technical issues or errors in lessons |
| 43 | +- **Translations**: Efforts to make these materials accessible in additional languages |
| 44 | +- **New Lesson Ideas**: Proposals for additional open science topics |
51 | 45 |
|
52 | | -## Managing Content |
| 46 | +For detailed contribution guidelines, please see our [content management guide (GUIDE.md)](GUIDE.md). |
53 | 47 |
|
54 | | -For detailed instructions on how to add lessons, update authors, or write blog posts, please refer to the **[GUIDE.md](GUIDE.md)** file in this repository. |
| 48 | +To contribute: |
| 49 | +1. Fork this repository |
| 50 | +2. Create a feature branch (`git checkout -b feature/your-feature-name`) |
| 51 | +3. Make your changes and commit them (`git commit -m 'Add some feature'`) |
| 52 | +4. Push to the branch (`git push origin feature/your-feature-name`) |
| 53 | +5. Open a Pull Request |
55 | 54 |
|
56 | | -### Key Data Files |
57 | | -* `src/data/lessons.yml`: The master list of all curriculum modules and external resources. |
58 | | -* `src/data/sitetext.yml`: Author profiles, staff list, and general site text. |
59 | | -* `src/content/blog/`: Markdown files for blog posts. |
| 55 | +## Credits and Acknowledgements |
60 | 56 |
|
61 | | -## Deployment |
| 57 | +This project is led by the **UCLA Library Data Science Center** and funded by the **Institute of Museum and Library Services (IMLS)** as part of the Laura Bush 21st Century Librarian Program. |
62 | 58 |
|
63 | | -This repository is configured with a GitHub Action (`.github/workflows/deploy.yml`) that automatically builds and deploys the site to GitHub Pages whenever changes are pushed to the `main` branch. |
| 59 | +### Project Team |
| 60 | + |
| 61 | +- **Todd Grappone** - University Librarian, UC Santa Barbara |
| 62 | +- **Tim Dennis** - Program Director, UCLA |
| 63 | +- **Zhiyuan Yao** - Program Coordinator, UCLA |
| 64 | +- **Zikang Eric Huang** - Lesson Infrastructure Developer, UCLA |
| 65 | +- **Lawrence Lee** - Lesson Infrastructure Developer, UCLA |
| 66 | +- **Madeline Kim** - Lesson Infrastructure Developer, UCLA |
| 67 | +- **Hyerin Lee** - UCLA |
| 68 | +- **Emily Gong** - UCLA |
| 69 | +- **Loretta Hu** - UCLA |
| 70 | +- **Elizabeth McAulay** - UCLA |
| 71 | + |
| 72 | +### Review Committee |
| 73 | + |
| 74 | +- **Chris Erdmann** - Head of Open Science, SciLifeLab Data Centre |
| 75 | +- **Cody Hennesy** - Computational Research Librarian |
| 76 | +- **Elaine Westbrooks** - Carl A. Kroch University Librarian, Cornell University Library |
| 77 | +- **Caroline Coward** - Information Science Manager, Jet Propulsion Lab, NASA |
| 78 | +- **Yvonne Ivey** - Program Manager, NASA TOPS |
| 79 | +- **Juliane Schneider** - Research Librarian, Pacific Northwest National Laboratory |
| 80 | + |
| 81 | +### Lesson Authors |
| 82 | + |
| 83 | +We are grateful to all lesson authors who have contributed their expertise to develop these curriculum modules. Individual lesson authors are credited on each lesson's repository and website. |
| 84 | + |
| 85 | +## Citation |
| 86 | + |
| 87 | +If you use these materials, please cite them as: |
| 88 | + |
| 89 | +Dennis, T., Lee, L., Lee, H., Yao, Z., Gong, E., Hu, L., Huang, Z. E., McAulay, E., Grappone, T., Erdmann, C., & Kim, M. (2025). *Lessons for Librarians in Open Science Principles and Methods* (Version 1.0.6) [Software]. Zenodo. https://doi.org/10.5281/zenodo.18055759 |
| 90 | + |
| 91 | +For detailed citation information in various formats, please see our [CITATION.cff](CITATION.cff) file. |
| 92 | + |
| 93 | +You can also cite this work using the DOI badge at the top of this README. |
64 | 94 |
|
65 | 95 | ## License |
66 | 96 |
|
67 | | -This project content is available under a Creative Commons Attribution 4.0 International License (CC-BY 4.0). |
| 97 | +The content of this project is licensed under the [Creative Commons Attribution 4.0 International License (CC-BY 4.0)](https://creativecommons.org/licenses/by/4.0/). |
| 98 | + |
| 99 | +The underlying source code used to format and display that content is licensed under the [MIT License](LICENSE.txt). |
| 100 | + |
| 101 | +See [LICENSE.txt](LICENSE.txt) for more details. |
| 102 | + |
| 103 | +## Authors |
| 104 | + |
| 105 | +- [Tim Dennis](https://github.com/jt14den) - [ORCID: 0000-0001-6632-3812](https://orcid.org/0000-0001-6632-3812) |
| 106 | +- [Lawrence Lee](https://github.com/lawrencenlee) - [ORCID: 0000-0003-1529-2002](https://orcid.org/0000-0003-1529-2002) |
| 107 | +- Hyerin Lee |
| 108 | +- [Zhiyuan Yao](https://github.com/zhiyuanyao) - [ORCID: 0000-0002-7601-8704](https://orcid.org/0000-0002-7601-8704) |
| 109 | +- Emily Gong |
| 110 | +- Loretta Hu |
| 111 | +- [Zikang Eric Huang](https://github.com/erhuang) - [ORCID: 0009-0007-9906-6067](https://orcid.org/0009-0007-9906-6067) |
| 112 | +- [Elizabeth McAulay](https://github.com/emcaulay) - [ORCID: 0000-0002-8679-9727](https://orcid.org/0000-0002-8679-9727) |
| 113 | +- [Todd Grappone](https://github.com/tgrappone) - [ORCID: 0000-0003-2218-7200](https://orcid.org/0000-0003-2218-7200) |
| 114 | +- [Christopher Erdmann](https://github.com/libcce) - [ORCID: 0000-0003-2554-180X](https://orcid.org/0000-0003-2554-180X) |
| 115 | +- [Madeline Kim](https://github.com/madelinekim) - [ORCID: 0000-0002-2213-201X](https://orcid.org/0000-0002-2213-201X) |
| 116 | + |
| 117 | +## Project Status and Activity |
| 118 | + |
| 119 | +### Current Status: **Active** ✅ |
| 120 | + |
| 121 | +The project is in active maintenance and development. All 14 lessons have been developed and are available for use and piloting. |
| 122 | + |
| 123 | +### Recent Activity |
| 124 | + |
| 125 | +- **December 2025**: DOI registered on Zenodo (10.5281/zenodo.18055759) |
| 126 | +- **2024-2025**: Beta piloting phase and Carpentries Incubator integration |
| 127 | +- **September-December 2024**: Lesson refinement and alpha piloting |
| 128 | +- **June-August 2024**: Collaborative lesson development workshop |
| 129 | +- **April-May 2024**: Accepted lesson proposals announced |
| 130 | + |
| 131 | +### Looking for Pilots! |
| 132 | + |
| 133 | +We are actively seeking community members to pilot these lessons. If you are interested in teaching or field-testing any of these materials, please [indicate your interest here](https://github.com/ucla-imls-open-sci/ucla-imls-open-sci.github.io/issues/new?template=pilot-interest.yml). |
| 134 | + |
| 135 | +--- |
| 136 | + |
| 137 | +## Technical Documentation |
| 138 | + |
| 139 | +### Tech Stack |
| 140 | + |
| 141 | +This site uses: |
| 142 | +- **Framework**: Astro (v5) |
| 143 | +- **Styling**: SCSS (Bootstrap-based Agency theme) |
| 144 | +- **Content**: YAML data files and Markdown |
| 145 | +- **Deployment**: GitHub Actions → GitHub Pages |
| 146 | + |
| 147 | +### Development |
| 148 | + |
| 149 | +#### Prerequisites |
| 150 | +- Node.js (v18 or higher recommended) |
| 151 | +- npm |
| 152 | + |
| 153 | +#### Quick Start |
| 154 | + |
| 155 | +1. Install dependencies: |
| 156 | + ```bash |
| 157 | + npm install |
| 158 | + ``` |
| 159 | + |
| 160 | +2. Start the local development server: |
| 161 | + ```bash |
| 162 | + npm run dev |
| 163 | + ``` |
| 164 | + Access the site at http://localhost:4321 |
| 165 | + |
| 166 | +3. Build for production: |
| 167 | + ```bash |
| 168 | + npm run build |
| 169 | + ``` |
| 170 | + The output will be generated in the `dist/` directory. |
| 171 | + |
| 172 | +### Managing Content |
| 173 | + |
| 174 | +For detailed instructions on how to add lessons, update authors, or write blog posts, please refer to [GUIDE.md](GUIDE.md). |
| 175 | + |
| 176 | +#### Key Data Files |
| 177 | +- `src/data/lessons.yml`: The master list of all curriculum modules and external resources |
| 178 | +- `src/data/sitetext.yml`: Author profiles, staff list, and general site text |
| 179 | +- `src/content/blog/`: Markdown files for blog posts |
| 180 | + |
| 181 | +--- |
| 182 | + |
| 183 | +## GitHub Topics |
| 184 | + |
| 185 | +This repository is tagged with the following topics for discoverability: |
| 186 | +- `lesson` |
| 187 | +- `carpentries` |
| 188 | +- `open-science` |
| 189 | +- `librarians` |
| 190 | +- `curriculum` |
| 191 | +- `data-science` |
| 192 | +- `reproducibility` |
| 193 | +- `imls` |
| 194 | +- `english` |
| 195 | +- `stable` |
| 196 | + |
| 197 | +--- |
| 198 | + |
| 199 | +**Funded by**: Institute of Museum and Library Services (IMLS) - Laura Bush 21st Century Librarian Program |
| 200 | +**Hosted by**: UCLA Library Data Science Center |
0 commit comments