Skip to content

Commit

Permalink
Merge pull request #16 from SIMEXP/iss12
Browse files Browse the repository at this point in the history
Iss12: improve contribution guidelines and beautify manifesto
  • Loading branch information
pbellec authored Jun 18, 2024
2 parents 19e5826 + 6c694cf commit 1b59f12
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 57 deletions.
56 changes: 0 additions & 56 deletions content/CONTRIBUTING.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ chapters:
- file: manifesto
- file: coc
- file: members
- file: CONTRIBUTING
- file: publications
- file: contributing
26 changes: 26 additions & 0 deletions content/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

This is a laboratory website maintained by the SIMEXP team. Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in the ways listed below.

## Improve the content

Fixing typos or suggestion changes to the text is very much appreciated. The layout can always be improved too! Whether you directly implement the changes or just make a general suggestion, do not hesitate to raise an issue.

## Add content

The SIMEXP website can always use more documentation on the laboratory operations. Any other idea is also welcome.

## Get Started

Ready to contribute? Here's how to set up `SIMEXP website` for local development.

1. Fork the repo on GitHub.
2. Clone your fork locally.
3. Install your local copy into a virtualenv, e.g., using `virtualenvwrapper` or `conda`.
4. Create a branch for local development and make changes locally.
5. Commit your changes and push your branch to GitHub.
6. Submit a pull request through the GitHub website.

## Code of Conduct

Please note that the SIMEXP website project is released with a [Code of Conduct](coc.md). By contributing to this project you agree to abide by its terms.
Binary file added content/images/brain_art.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/hacking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions content/manifesto.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Academia means different things to different people. The laboratory for brain simulation and exploration (SIMEXP) is founded on a fairly opinionated, and possibly unusual view of what academia is. This document tries to make the SIMEXP academic values explicit. It does not mean that everybody at SIMEXP shares all of these values, or operates under a particular value at all times. These values are rather guiding principles for many key aspects of the operations of the lab, and form a baseline for expectations.

![Hacking](images/hacking.png)
## The hacker way
Sharing is a key aspect of all academic communities, but how that sharing works varies widely. Lots of academic collaborations are transactional in nature, with people exchanging one contribution for another. Original founders of free software and the hacker movement operate under very different, simple rules. If you want to learn about something, just ask and you can expect an answer. The day somebody wants to learn something from you, you are expected to help that person. Don’t try to balance out what you get and give to a particular person. By helping others, you’re just building up karma, doing good to your community and the world. A corollary of that collaborative ethos is to strive to openly share as much research material as possible, data, code and ideas. The sharing process is greatly facilitated by adopting tools designed for sharing in your daily research activities (“open by design”).

Expand All @@ -11,6 +12,7 @@ Some laboratories operate under pretty strict labor division, with technical ass
## Automate all the things
Neural data science requires us to iterate analyses a lot, to explore new ideas, replicate analyses on new datasets, and test the impact of various hyper-parameters. This means that data analysis operations should be automated to the greatest extent possible.

![Brain art](images/brain_art.jpg)
## The academic game is not the endgame
Academia is a highly competitive environment. Some individuals end up focussing their work based on the metrics used to assess them, out of fear of not surviving the game, or simply thinking that it is what the academic community expects them to do. This means that many labs expend considerable energy towards publishing in high impact-factor journals, apply to awards, attend as many conferences as possible, get invited presentations, and sit on many committees, amongst others. The SIMEXP lab does of course support the careers of lab members, whether academic or not, and makes strategic investment of resources towards these metrics. But it is critical to not lose sight that pretty much none of us went into academia to work towards these metrics. The endgame of SIMEXP is to solve problems, namely prognosis of Alzheimer’s disease, and building human-like artificial neural networks. The academic game is a means to these ends. Nothing more. We aim to keep our collective and individual academic boats afloat with bare minimum required efforts, and are committed to not let the academic game ruin the fun and joy we have doing research. We rightfully trust that doing elite research, prioritizing quality over quantity, is all it really takes to strive inside and outside of academia anyway.

Expand Down

0 comments on commit 1b59f12

Please sign in to comment.