Skip to content
Snippets Groups Projects
Commit 83a65441 authored by María José Ramos's avatar María José Ramos
Browse files

Adding info files

parent 8e30d76f
No related branches found
No related tags found
No related merge requests found
# Git&Zenodo Assistant
## Git
Here, you can read the information available in the Git&Zenodo Assistant review about Git. It also includes the Git comands used in the program. At the end, you will find the respective documentation if you want to know more.
<CENTER>
<h2> Git&Zenodo Assistant: review about Git </h2>
<img src="images_tutorial/git_review.png">
</CENTER>
### What is Git?
* * *
Git is more than a website, Git is a control version software, which is a software made for tracking changes in any set of files in a directory.
Managing changes of your documents, data, notebooks and coding scripts is essential when you do research. As you probably have learned by now, just copying your files and renaming them as "myProjectUpdateFinalTrueFinalPrint.ipynb" is not the most efficient way to do so. Git makes it easier by providing an online plataform for Version Control of personal and collaborative projects.
### What is a Git repository?
* * *
The Git software stores and save files to a directory called repository, also shorten as repo. A Git repository allows various operations to create different versions of the files in it.
A Git repository can be local (placed in your computer) or remote (hosted on the Internet, or in a different server).
By installing git to your computer, and creating a GitHub or GitLab account you can start your Version Control with git.
### What does a git fork/git clone do?
* * *
From Github or Gitlab you can Fork and Clone repositories.
A git fork is an operation of copying a repository to your git account.
A git clone is an operation of copying a repository to your local machine.
Maybe you knew all of this already. In fact, you probably have this program running because you did a git clone to your computer (or Virtual Machine, for that matter).
One more thing before you continue: remember than you can only push to git repositories where you have permissions to do so. If you need to clone a repo that you do not own and need to make changes, fork the repo first and then you can clone it.
### What does a git init do?
* * *
You can obtain a Git repository by either cloning a Git repository or by converting a local directory to a Git repository, using git init.
It does not matter if the directory is a new local directory, or an already existent local directory, the command git init works in both cases.
And you can also git init a git repository, is it safe to do so, it will not overwrite files that are already there.
### Git push and the previous steps.
* * *
Git push is an operation to publish new local commits on a remote server.
When you want to update your changes (could be a new file in the directory, or a change in an already existing file) to your Git account, you need to git push.
But before a git push, you have to git add (to add your new or modified files to your git repo), git commit (to save these changes) and then you an execute your git push command.
There could be more commands that you need to execute before a git push.
This is only a basic review, and although the tutorial will include some new steps. You can learn more in the documentation and you should.
### Git pull
* * *
While Git push allows you to publish local commits on a remote server, the git pull command lets you update the local version with the new commits saved on the remote server. It is the most common way to update a repository and you should use it after everytime that you interact with the remote server.
Note that this tutorial does not include how to git pull although it is being considered for future versions. If you need to git pull, we recommend to consult the documentation available in the repository and the program.
## Documentation
[1] [GitHub: Home Page](https://github.com/)
[2] [GitLab: About GitLab](https://about.gitlab.com/)
[3] [Install Git](https://github.com/git-guides/install-git)
[4] [GitHub documentation](https://docs.github.com/en)
[5] [GitHub community documentation](https://git-scm.com/site)
# Git&Zenodo Assistant
## Zenodo
Here, you can read the information available in the Git&Zenodo Assistant review about Zenodo. At the end, you will find the respective documentation if you want to know more.
<CENTER>
<h2> Git&Zenodo Assistant: review about Zenodo </h2>
<img src="images_tutorial/zenodo_review.png">
</CENTER>
### What is Zenodo?
* * *
Zenodo is a website where you can upload and publish files. It is funded by CERN, OpenAIRE and the EU.
It is built and developed by researchers who want to promote Open Science and welcome research from all nations and disciplines, to help scientific work to be more shareable and citeable.
Currently, all meta data is openly available under CC0 licence, and all open content is openly accessible through open APIs
### Uploading and Publishing
* * *
You can upload many types of files to Zenodo: publications, posters, presentations, datasets, images, videos, audios, softwares, lessons, all research outputs from all fields of science are welcome, and they are currently accepting up to 50GB per dataset!
When your files are ready, you can publish them, so they will be permanently available on the Internet: your work will be stored safely and it will be easier to cite, discover and share, considering
flexible licensing (although Zenodo encourages you to share your
research as openly as possible).
### What is DOI Versioning?
* * *
A DOI (Digital Object Identifier) is a unique string of numbers, letters, and symbols used to identify objects (like your scientific publication).
DOIs are standardized and assigned by a registration agency.
Zenodo supports DOI versioning by providing your published work two DOIs, allowing you to:
* Edit/update the record’s files after they have been published.
* Cite a specific version of a record.
* Cite all of versions of a record.
This makes your work easier to identify, search and cite.
### What is metadata?
* * *
Metadata is a set of data that contains information about other data.
While uploading a file to Zenodo, and before you publish it in the website, you have to provide important data about your file, like its title, creators, and type, which represents its metadata.
Not only this is a requirement of Zenodo, but it is very useful: it helps to describe your work, making it easier to find and identify, and it also makes it more accesible, by using a standard format and vocabulary.
## Documentation
[1] [Zenodo: Home Page](https://zenodo.org/)
[2] [About Zenodo](https://about.zenodo.org/)
[3] [Zenodo: FAQ](https://help.zenodo.org/)
[4] [Zenodo: FAQ-DOI Versioning](https://help.zenodo.org/#versioning)
[5] [Zenodo: Principles-Metadata](https://about.zenodo.org/principles/)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment