RSD DocumentationFind and judge the relevance and quality of research software.
Encourages research software engineers to make their research software findable and accessible, ensuring recognition of their work.
Facilitates research institutes to showcase the software produced by their organization and monitor its reuse and impact.
RSD DocumentationBefore you can add a project, you will need have access to the RSD (see How to get access) and Sign in.
After signing in, use the "+" button next to your avatar icon on the top right of the page, and select "New Project":
Before the project page is created, you must provide a Title and Subtitle for your project:
The RSD will automatically generate a slug for your project based on the project name you have provided. This slug will become part of the URL on which your project page can found. There is a small chance the generated slug is already in use by another project. If this is the case, an error will be show and you will need to change the slug resolve this conflict.
WARNING
After you save the project page the slug can no longer be changed! You can still change the title or subtitle of the project however.
Once you click "save" the RSD will initialize a new empty project page. This page will not be public yet to give you some time to provide additional information. Next, you can add additional information in the 7 sections explained below.
On this page, you can add and change the basic information about the project. This includes:
In addition, the sidebar on the right shows:
While entering this information, any changes you make are stored automatically. You can view the resulting page by clicking view page in the top right corner. Click the pencil icon in the top right to get back to the editing view.
TIP
Choose your Title, Subtitle, Keywords and Research domains wisely, as they are used by visitors of the RSD for searching and filtering content!
In the top right corner of the page, you can find a "View page" link, which you can use at any time to inspect the resulting project page:
The "Published slider can be use to make the page public once you are satisfied with the result.
To return to editing the page use the 
link in the top right.
On this page, you can add team members to the project. Using the search bar on the left, you can search for persons registered in the RSD and ORCID databases using their name or ORCID. To add a team member, select the person from the drop down list of search results, or select "Add ...." to manually add a person if no information is found in the RSD or ORCID.
Next, a pop up appears with the information available on this team member:
You can correct the available information and add any missing fields before adding this person to the team. The information stored about each team member is specific to this project. Therefore, you can safely change information about this person without having an effect on any other project the person is involved in.
DANGER
When manually adding team members or adding images or email adresses of persons, please ensure you have persmission to share this information!
On this page, you can add participating organizations to the project. Using the search bar on the left, you can search for organizations listed in the RSD and ROR databases using their name or ROR identifier. To add a participating organization, select the organization from the drop down list of search results, or select "Add ...." to manually add an organization if no information is found in the RSD or ROR.
Next, a pop up appears with the information available on this organization:
The information on organizations found in the RSD or ROR database are (mostly) read-only. When adding a new organization from ROR, you can only add a logo for this organization. All other information is retrieved automatically.
WARNING
Regular users cannot update an organization after adding it to the RSD. Only the organization maintainer (for registered organizations) or the RSD administrators can update this information. Please contact us if you need to update organization information.
In the next two sections, you can add Impact and Output to projects. These entries may consist of other research outputs such as publications, dataset, book sections, blogs, etc. Where Output typically consists of research output being produced by the project team itself, Impact is generally triggered by events outside of the project, such as re-use of results in other projects, publications, or society, items in the media, etc.
To add items, the search bar on the left can be used to search the RSD, Crossref, and DataCite databases using the Title or DOI of the research output. An item can be added by selecting it from the list of search results. The RSD will automatically classify the item based on the available metadata.
If needed, items without a DOI can also be added manually. After clicking "Add" a popup will appear to provide the details of this item.
Each manually added item should at least have a Title, Type and URL. All other fields are optional. The Note field can be used to add a note to this item, and will not be shown on the project page.
WARNING
Please check if the information is complete and correct. A manual item can not be edited after it has been saved!
The related topics section can be used to link related projects and software pages in the RSD to this project page. Items can be added by simply typing (part) of the name in either search bars, and selecting the desired item from the search result list.
TODO
Once you are satisfied with the information you have entered for each of the sections, you can publish the software page to make it publicly available. To do so, use the "Published" slider on the information page and use the "View page link to admire the result:
Don't hesitate to update and extend the page later!
RSD DocumentationBefore you can add software, you will need have access to the RSD (see How to get access) and Sign in.
After signing in, you can use the "+" button next to your avatar icon on the top right of the page, and from the drop down menu select "New Software":
To create a new software page, you must provide a name for your software and a short description of what it does. Once you click "save" the RSD will use this information to initialize a new empty software page. This software page is not be public yet to give you some time to provide additional information.
Next, you can add additional information in the 7 sections explained below.
In this section you can provide the basic information about the software:
In this section, you can provide more information on who contributed to the software. This section can be used to list the developers, designers, community managers, etc. If you have provided a concept DOI in the previous section, you can import the contributors from the DOI metadata by clicking the "import contributors" button. Alternatively / additionally you can use the search bar underneath "Add contributor" to search for people already registered in the RSD or ORCID database. If needed, you can add a role and affiliation to the contributor, and select one contributor as a "contact person" for the software.
The contributors you add will show up in the contributors section of the software page.
In this section, you can list which organizations contributed to the development of the software. You can use the search bar underneath "Add organization" to search for organizations already registered in the RSD or in the ROR database.
This section allows you to add mentions to your software page. You can use this to list publications, presentations, videos, blogs, etc. that prominently feature your software, or the results produced by your software. To add a mention, you can use the search bar below "Find publication" to search for a DOI or publication title in the RSD, Crossref or Datacite. All the relevant data about the publication will be retrieved automatically. For publications without a DOI (typically blogs or webpages), it is also possible to manually add a mention.
This section allows user testimonials to be added to the software page. A testimonial consist of a quote and a source.
Once you are satisfied with the data you have entered for the different sections, you can publish the software page to make it publicly available. Don't hesitate to update and extend the page later!
TODO
RSD DocumentationAPI Documentation in progress.
After signing in, use the "+" button next to your avatar icon on the top right of the page, and select "New Project":
Before the project page is created, you must provide a Title and Subtitle for your project:
The RSD will automatically generate a slug for your project based on the project name you have provided. This slug will become part of the URL on which your project page can found. There is a small chance the generated slug is already in use by another project. If this is the case, an error will be show and you will need to change the slug resolve this conflict.
WARNING
After you save the project page the slug can no longer be changed! You can still change the title or subtitle of the project however.
Once you click "save" the RSD will initialize a new empty project page. This page will not be public yet to give you some time to provide additional information. Next, you can add additional information in the 7 sections explained below.
On this page, you can add and change the basic information about the project. This includes:
',10),N=e("li",null,[t("The "),e("strong",null,"title"),t(" of the project")],-1),q=e("li",null,[t("A "),e("strong",null,"subtitle"),t(" (which briefly explains the topic).")],-1),C=e("li",null,[t("An "),e("strong",null,"image"),t(" illustrating the topic or goal of the project")],-1),P=t("A "),W=e("strong",null,"description",-1),E=t(" of the project (written in "),L={href:"https://www.markdownguide.org",target:"_blank",rel:"noopener noreferrer"},V=t("markdown"),B=t(")."),G=e("p",null,"In addition, the sidebar on the right shows:",-1),U=e("li",null,[t("The "),e("strong",null,"publication status")],-1),Y=e("li",null,[t("A "),e("strong",null,"start date"),t(" and "),e("strong",null,"end date")],-1),F=e("li",null,[t("A "),e("strong",null,"Grant ID")],-1),K=t("The "),H=e("strong",null,"funding organization(s)",-1),M=t(" as listed in the RSD or the "),$={href:"https://ror.org",target:"_blank",rel:"noopener noreferrer"},J=t("ROR database"),Q=e("li",null,[t("A list of relevant "),e("strong",null,"Project links"),t(" (such as a project web page, github organization, etc.)")],-1),X=t("The "),Z=e("strong",null,"Research domain(s)",-1),tt=t(" of this project (as defined by the "),et={href:"https://erc.europa.eu/news/new-erc-panel-structure-2021-and-2022",target:"_blank",rel:"noopener noreferrer"},ot=t("ERC"),nt=t(")"),at=e("li",null,[e("strong",null,"Keywords"),t(" for this project")],-1),it=a('While entering this information, any changes you make are stored automatically. You can view the resulting page by clicking view page in the top right corner. Click the pencil icon in the top right to get back to the editing view.
TIP
Choose your Title, Subtitle, Keywords and Research domains wisely, as they are used by visitors of the RSD for searching and filtering content!
In the top right corner of the page, you can find a "View page" link, which you can use at any time to inspect the resulting project page:
The "Published slider can be use to make the page public once you are satisfied with the result.
To return to editing the page use the link in the top right.
Next, a pop up appears with the information available on this team member:
You can correct the available information and add any missing fields before adding this person to the team. The information stored about each team member is specific to this project. Therefore, you can safely change information about this person without having an effect on any other project the person is involved in.
DANGER
When manually adding team members or adding images or email adresses of persons, please ensure you have persmission to share this information!
Next, a pop up appears with the information available on this organization:
The information on organizations found in the RSD or ROR database are (mostly) read-only. When adding a new organization from ROR, you can only add a logo for this organization. All other information is retrieved automatically.
WARNING
Regular users cannot update an organization after adding it to the RSD. Only the organization maintainer (for registered organizations) or the RSD administrators can update this information. Please contact us if you need to update organization information.
In the next two sections, you can add Impact and Output to projects. These entries may consist of other research outputs such as publications, dataset, book sections, blogs, etc. Where Output typically consists of research output being produced by the project team itself, Impact is generally triggered by events outside of the project, such as re-use of results in other projects, publications, or society, items in the media, etc.
',7),_t=t("To add items, the search bar on the left can be used to search the RSD, "),ft={href:"https://crossref.org",target:"_blank",rel:"noopener noreferrer"},bt=t("Crossref"),yt=t(", and "),wt={href:"https://datacite.org",target:"_blank",rel:"noopener noreferrer"},vt=t("DataCite"),jt=t(" databases using the "),Rt=e("strong",null,"Title",-1),Tt=t(" or "),kt=e("strong",null,"DOI",-1),Dt=t(" of the research output. An item can be added by selecting it from the list of search results. The RSD will automatically classify the item based on the available metadata."),xt=a('If needed, items without a DOI can also be added manually. After clicking "Add" a popup will appear to provide the details of this item.
Each manually added item should at least have a Title, Type and URL. All other fields are optional. The Note field can be used to add a note to this item, and will not be shown on the project page.
WARNING
Please check if the information is complete and correct. A manual item can not be edited after it has been saved!
The related topics section can be used to link related projects and software pages in the RSD to this project page. Items can be added by simply typing (part) of the name in either search bars, and selecting the desired item from the search result list.
TODO
Once you are satisfied with the information you have entered for each of the sections, you can publish the software page to make it publicly available. To do so, use the "Published" slider on the information page and use the "View page link to admire the result:
Don't hesitate to update and extend the page later!
',13);function Ot(It,zt){const i=s("RouterLink"),n=s("ExternalLinkIcon");return d(),h(l,null,[D,e("p",null,[x,o(i,{to:"/getting-access.html"},{default:r(()=>[O]),_:1}),I,o(i,{to:"/getting-access.html#how-to-sign-in"},{default:r(()=>[z]),_:1}),A]),S,e("ul",null,[N,q,C,e("li",null,[P,W,E,e("a",L,[V,o(n)]),B])]),G,e("ul",null,[U,Y,F,e("li",null,[K,H,M,e("a",$,[J,o(n)])]),Q,e("li",null,[X,Z,tt,e("a",et,[ot,o(n)]),nt]),at]),it,e("p",null,[st,e("a",rt,[ct,o(n)]),dt]),ht,e("p",null,[lt,e("a",pt,[gt,o(n)]),ut]),mt,e("p",null,[_t,e("a",ft,[bt,o(n)]),yt,e("a",wt,[vt,o(n)]),jt,Rt,Tt,kt,Dt]),xt],64)}var Nt=c(k,[["render",Ot],["__file","adding-projects.html.vue"]]);export{Nt as default}; diff --git a/assets/adding-software.html.ac410caf.js b/assets/adding-software.html.ac410caf.js new file mode 100644 index 0000000..78ec94a --- /dev/null +++ b/assets/adding-software.html.ac410caf.js @@ -0,0 +1 @@ +import{_ as h,r as n,o as c,c as d,a as e,b as o,w as r,F as l,d as t,e as s}from"./app.60036ba8.js";import{_ as u}from"./plus-software-projects.0962d84b.js";var f="/documentation/software-information.gif",p="/documentation/contributors.gif",m="/documentation/organizations.gif",g="/documentation/mentions.gif",_="/documentation/testimonials.gif",w="/documentation/finale.gif";const b={},y=e("h1",{id:"adding-software",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#adding-software","aria-hidden":"true"},"#"),t(" Adding software")],-1),v=t("Before you can add software, you will need have access to the RSD (see "),x=t("How to get access"),k=t(") and "),D=t("Sign in"),I=t("."),O=s('After signing in, you can use the "+" button next to your avatar icon on the top right of the page, and from the drop down menu select "New Software":
To create a new software page, you must provide a name for your software and a short description of what it does. Once you click "save" the RSD will use this information to initialize a new empty software page. This software page is not be public yet to give you some time to provide additional information.
Next, you can add additional information in the 7 sections explained below.
In this section you can provide the basic information about the software:
This section allows user testimonials to be added to the software page. A testimonial consist of a quote and a source.
Once you are satisfied with the data you have entered for the different sections, you can publish the software page to make it publicly available. Don't hesitate to update and extend the page later!
TODO
',9);function Q(W,X){const i=n("RouterLink"),a=n("ExternalLinkIcon");return c(),d(l,null,[y,e("p",null,[v,o(i,{to:"/getting-access.html"},{default:r(()=>[x]),_:1}),k,o(i,{to:"/getting-access.html#how-to-sign-in"},{default:r(()=>[D]),_:1}),I]),O,e("p",null,[T,R,A,e("a",S,[q,o(a)]),z]),L,N,B,e("p",null,[C,e("a",F,[V,o(a)]),Y]),E,M,e("p",null,[U,e("a",G,[H,o(a)]),K,e("a",$,[j,o(a)]),J]),P],64)}var te=h(b,[["render",Q],["__file","adding-software.html.vue"]]);export{te as default}; diff --git a/assets/adding-software.html.d22a7e62.js b/assets/adding-software.html.d22a7e62.js new file mode 100644 index 0000000..6d34a8c --- /dev/null +++ b/assets/adding-software.html.d22a7e62.js @@ -0,0 +1 @@ +const e={key:"v-1f82dedf",path:"/adding-software.html",title:"Adding software",lang:"en-US",frontmatter:{},excerpt:"",headers:[{level:2,title:"Basic information",slug:"basic-information",children:[]},{level:2,title:"Contributors",slug:"contributors",children:[]},{level:2,title:"Organizations",slug:"organizations",children:[]},{level:2,title:"Mentions",slug:"mentions",children:[]},{level:2,title:"Testimonials",slug:"testimonials",children:[]},{level:2,title:"The finished page",slug:"the-finished-page",children:[]},{level:2,title:"Maintainers",slug:"maintainers",children:[]}],git:{updatedTime:1668516783e3,contributors:[{name:"Jason Maassen",email:"jmaassen73@gmail.com",commits:13},{name:"Pietro Monticone",email:"38562595+pitmonticone@users.noreply.github.com",commits:1}]},filePathRelative:"adding-software.md"};export{e as data}; diff --git a/assets/api.html.c657d687.js b/assets/api.html.c657d687.js new file mode 100644 index 0000000..41b955a --- /dev/null +++ b/assets/api.html.c657d687.js @@ -0,0 +1 @@ +import{_ as a,o as t,c as r,F as n,a as e,d as o}from"./app.60036ba8.js";const s={},c=e("h1",{id:"api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#api","aria-hidden":"true"},"#"),o(" API")],-1),i=e("p",null,"API Documentation in progress.",-1);function _(d,l){return t(),r(n,null,[c,i],64)}var p=a(s,[["render",_],["__file","api.html.vue"]]);export{p as default}; diff --git a/assets/api.html.ec20e14b.js b/assets/api.html.ec20e14b.js new file mode 100644 index 0000000..d6a12a2 --- /dev/null +++ b/assets/api.html.ec20e14b.js @@ -0,0 +1 @@ +const t={key:"v-0d9af0f8",path:"/api.html",title:"API",lang:"en-US",frontmatter:{},excerpt:"",headers:[],git:{updatedTime:1657095699e3,contributors:[{name:"Jesu\u0301s Garci\u0301a",email:"ctw@ctwhome.com",commits:1}]},filePathRelative:"api.md"};export{t as data}; diff --git a/assets/app.60036ba8.js b/assets/app.60036ba8.js new file mode 100644 index 0000000..c715982 --- /dev/null +++ b/assets/app.60036ba8.js @@ -0,0 +1,8 @@ +var Dl=Object.defineProperty,$l=Object.defineProperties;var Hl=Object.getOwnPropertyDescriptors;var Po=Object.getOwnPropertySymbols;var Ml=Object.prototype.hasOwnProperty,Nl=Object.prototype.propertyIsEnumerable;var To=(e,t,n)=>t in e?Dl(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n,ze=(e,t)=>{for(var n in t||(t={}))Ml.call(t,n)&&To(e,n,t[n]);if(Po)for(var n of Po(t))Nl.call(t,n)&&To(e,n,t[n]);return e},Pn=(e,t)=>$l(e,Hl(t));const Qt={};function Gr(e,t){const n=Object.create(null),r=e.split(",");for(let o=0;oWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our community include:
Examples of unacceptable behavior include:
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rsd@esciencecenter.nl All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
A contribution can be one of the following cases:
The sections below outline the steps in each case.
For general questions (not directly related to the development of the software) you can send an email to rsd@esciencecenter.nl. Alternatively, you can also submit an issue:
',6),Y=t("use the search functionality "),F={href:"https://github.com/research-software-directory/RSD-as-a-service/issues",target:"_blank",rel:"noopener noreferrer"},G=t("here"),L=t(" to see if someone already filed the same issue;"),N=e("li",null,"if you find a similar issue, you can add your own comments to this issue;",-1),V=e("li",null,"if your issue search did not yield any relevant results, make a new issue;",-1),A=e("li",null,'apply the "question" label; apply other labels when relevant.',-1),B=e("h2",{id:"you-have-found-a-bug",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#you-have-found-a-bug","aria-hidden":"true"},"#"),t(" You have found a bug")],-1),E=e("p",null,"If you find a bug or experience unexpected behavior, you can submit an issue:",-1),W=t("use the search functionality "),P={href:"https://github.com/research-software-directory/RSD-as-a-service/issues",target:"_blank",rel:"noopener noreferrer"},j=t("here"),J=t(" to see if someone already filed the same issue;"),K=e("li",null,"if you find a similar issue, you can add your own comments to this issue;",-1),U=t("if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue and your technical expertise, you may want to include: "),z=t("the "),M={href:"https://help.github.com/articles/autolinked-references-and-urls/#commit-shas",target:"_blank",rel:"noopener noreferrer"},O=t("SHA hashcode"),Q=t(" of the commit that is causing your problem;"),X=e("li",null,"some identifying information (name and version number) for the version you're using;",-1),Z=e("li",null,"information about the operating system and browser you are using;",-1),$=e("li",null,'apply the "bug" label; apply other labels when relevant.',-1),ee=e("h2",{id:"you-want-to-request-a-feature",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#you-want-to-request-a-feature","aria-hidden":"true"},"#"),t(" You want to request a feature")],-1),te=e("p",null,"To request a feature you can submit an issue on GitHub. Please keep in mind that our development resources are limited, so we may not be able to honor your request.",-1),oe=t("use the search functionality "),ne={href:"https://github.com/research-software-directory/RSD-as-a-service/issues",target:"_blank",rel:"noopener noreferrer"},se=t("here"),ie=t(" to see if someone already filed the same issue;"),re=e("li",null,"if you find a similar issue, you can add your own comments and suggestions to this issue (having more people request the same feature may increase its priority);",-1),ae=e("li",null,"if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the feature you are requesting. We may get back to you with further questions.",-1),ue=e("li",null,'apply the "feature" label; apply other labels when relevant.',-1),he=e("h2",{id:"you-want-to-make-some-kind-of-change-to-the-code-base-yourself",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#you-want-to-make-some-kind-of-change-to-the-code-base-yourself","aria-hidden":"true"},"#"),t(" You want to make some kind of change to the code base yourself")],-1),le=e("p",null,"Contributions to the code base are very welcome. Keep in mind, however, that this also requires a good interaction with the community to ensure that your contribution is adopted.",-1),ce=e("li",null,[t("("),e("strong",null,"important"),t(") announce your plan to the rest of the community "),e("em",null,"before you start working"),t(". This announcement should be in the form of a (new) issue;")],-1),de=e("li",null,[t("("),e("strong",null,"important"),t(") wait until some kind of consensus is reached about your idea is a good idea;")],-1),_e=t("if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions "),fe={href:"https://help.github.com/articles/configuring-a-remote-for-a-fork/",target:"_blank",rel:"noopener noreferrer"},me=t("here"),ye=t(" and "),be={href:"https://help.github.com/articles/syncing-a-fork/",target:"_blank",rel:"noopener noreferrer"},pe=t("here"),ge=t(");"),we=e("li",null,"make sure the existing unit tests still work;",-1),ke=e("li",null,"make sure that the existing integration tests still work;",-1),ve=e("li",null,"add your own unit tests and integration tests (if necessary);",-1),qe=e("li",null,"update or expand the documentation;",-1),xe={href:"http://rogerdudler.github.io/git-guide/",target:"_blank",rel:"noopener noreferrer"},Se=t("push"),Re=t(" your feature branch to (your fork of) the repository on GitHub;"),Ce=t("create a pull request, e.g. following the instructions "),De={href:"https://help.github.com/articles/creating-a-pull-request/",target:"_blank",rel:"noopener noreferrer"},He=t("here"),Te=t("."),Ie=e("p",null,"In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request (have a look at some of our old pull requests to see how this works.",-1),Ye=e("h2",{id:"you-want-to-contribute-in-some-other-way",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#you-want-to-contribute-in-some-other-way","aria-hidden":"true"},"#"),t(" You want to contribute in some other way")],-1),Fe=e("p",null,"Contributions to the code are by no means the only way to contribute to the Research Software Directory. If you wish to contribute in some other way, please contact us at rsd@esciencecenter.nl.",-1);function Ge(Le,Ne){const n=s("ExternalLinkIcon"),i=s("RouterLink");return a(),u(l,null,[_,f,m,e("p",null,[y,e("a",b,[p,o(n)]),g,w,k,v,q,e("a",x,[S,o(n)]),R]),C,e("p",null,[D,o(i,{to:"/code-of-conduct.html"},{default:h(()=>[H]),_:1}),T]),I,e("ol",null,[e("li",null,[Y,e("a",F,[G,o(n)]),L]),N,V,A]),B,E,e("ol",null,[e("li",null,[W,e("a",P,[j,o(n)]),J]),K,e("li",null,[U,e("ul",null,[e("li",null,[z,e("a",M,[O,o(n)]),Q]),X,Z])]),$]),ee,te,e("ol",null,[e("li",null,[oe,e("a",ne,[se,o(n)]),ie]),re,ae,ue]),he,le,e("ol",null,[ce,de,e("li",null,[_e,e("a",fe,[me,o(n)]),ye,e("a",be,[pe,o(n)]),ge]),we,ke,ve,qe,e("li",null,[e("a",xe,[Se,o(n)]),Re]),e("li",null,[Ce,e("a",De,[He,o(n)]),Te])]),Ie,Ye,Fe],64)}var Ae=r(d,[["render",Ge],["__file","contributors.html.vue"]]);export{Ae as default}; diff --git a/assets/contributors.html.f9c76cee.js b/assets/contributors.html.f9c76cee.js new file mode 100644 index 0000000..2dc8a9a --- /dev/null +++ b/assets/contributors.html.f9c76cee.js @@ -0,0 +1 @@ +const e={key:"v-20e7df08",path:"/contributors.html",title:"Contributors",lang:"en-US",frontmatter:{},excerpt:"",headers:[{level:2,title:"Contributing to the Research Software Directory (as a Service)",slug:"contributing-to-the-research-software-directory-as-a-service",children:[]},{level:2,title:"Code of conduct",slug:"code-of-conduct",children:[]},{level:2,title:"How to contribute",slug:"how-to-contribute",children:[]},{level:2,title:"You have a question, suggestion, comment, etc.",slug:"you-have-a-question-suggestion-comment-etc",children:[]},{level:2,title:"You have found a bug",slug:"you-have-found-a-bug",children:[]},{level:2,title:"You want to request a feature",slug:"you-want-to-request-a-feature",children:[]},{level:2,title:"You want to make some kind of change to the code base yourself",slug:"you-want-to-make-some-kind-of-change-to-the-code-base-yourself",children:[]},{level:2,title:"You want to contribute in some other way",slug:"you-want-to-contribute-in-some-other-way",children:[]}],git:{updatedTime:1657095699e3,contributors:[{name:"Jesu\u0301s Garci\u0301a",email:"ctw@ctwhome.com",commits:1}]},filePathRelative:"contributors.md"};export{e as data}; diff --git a/assets/embed.html.a56c91ad.js b/assets/embed.html.a56c91ad.js new file mode 100644 index 0000000..2b7122e --- /dev/null +++ b/assets/embed.html.a56c91ad.js @@ -0,0 +1,6 @@ +import{_ as a,e as n}from"./app.60036ba8.js";const s={},t=n(`This feature allows you to embed the RSD Software and Projects as an IFrame in your website. The Header and the Footer are automatically hidden and users will be able to navigate between the main list and the document.
Html test page: Test: https://www.research-software.dev/embed_example.html
<h2>Check our Software - Demo Embed pages</h2>
+<iframe src="http://localhost/software?embed" title="RSD Software" width="100%" height="500" frameBorder="0"></iframe>
+
+<h2>Check our Projects - Demo Embed pages</h2>
+<iframe src="http://localhost/projects?embed" title="RSD Software" width="100%" height="500" frameBorder="0"></iframe>
+To sign in to the RSD, go to the "Sign in" button at the top right corner of the page and select the identity provider you wish to use:
Next, you will be redirected to a login page of the selected identity provider. After providing you credentials you will return to the RSD page you came from. If you sign in to the RSD for the first time, the identify provider may ask you permission to share information with the RSD.
To sign out, you can use the profile button the top right corner of the page and select "Logout":
Using the search bar in the header, you can perform a global search of all data in the RSD by simply providing a search term. Currently, the search will match the following fields:
At the moment, we do not yet match on the long descriptions of software, projects and organizations, but we expect to do so in the future.
The software overview page provides a list of all software in the RSD. For each software, a card is shown with basic information: name, short description, last update, number of mentions, and number of contributors. To browse and search for software of interest, the filter and search bar on the top of the page can be used:
Simply typing into the search bar will trigger the RSD to search for software containing (part of) the terms you entered. The name, short description and keywords are included in the search. Entering multiple words into the search bar will be interpreted as an AND. Only software containing all search terms will be shown as a result.
By default, 12 software cards are shown per page. This number can be increased if desired using the Per page dropdown menu. The < and > icons can be used to move between pages.
It is also possible to filter the software by keywords. By clicking the filter icon a filter popup will appear allowing you to select (or type) one or more keywords used by software in the RSD:
Selecting multiple keywords is interpreted as an AND. Only software using all of the selected keywords will be shown as a result. You can also combine the keyword filters with search terms to further reduce the selection.
The project overview page provides a list of all projects in the RSD. For each project, a card is shown with basic information: name, short description, last update, and if the project is running or completed. To browse and search for projects of interest, the filter and search bar on the top of the page can be used:
Simply typing into the search bar will trigger the RSD to search for projects containing (part of) the terms you entered. The name, short description, keywords, and research domains are included in the search. Entering multiple words into the search bar will be interpreted as an AND. Only projects containing all search terms will be shown as a result.
By default, 12 project cards are shown per page. This number can be increased if desired using the Per page dropdown menu. The < and > icons can be used to move between pages.
It is also possible to filter the projects by keywords and/or research domains. By clicking the filter icon a filter popup will appear allowing you to select (or type) one or more keywords and research domains used by projects in the RSD:
Selecting multiple keywords and research domains is interpreted as an AND. Only software using all of the selected keywords and research domains will be shown as a result. You can also combine the keyword filters with search terms to further reduce the selection.
The organization overview page provides a list of all organizations listed in the RSD. For each organization, a card is shown basic information: name, logo, and the number of software and project pages which this organization participates in.
',25),A=t("For organizations which are a registered member of the RSD, the "),E=e("img",{src:y,alt:"image"},null,-1),F=t(" checkmark is shown on the card. If you wish to register your organization, you can find more information in "),I=t("How to register an organization"),P=t("."),L=i('To browse and search for organizations of interest, the search bar on the top of the page can be used:
Simply typing into the search bar will trigger the RSD to search for organization whose name contains (part of) the terms you entered. Entering multiple words into the search bar will be interpreted as an AND. Only organizations whose name contains all search terms will be shown as a result.
By default, 12 organization cards are shown per page. This number can be increased if desired using the Per page dropdown menu. The < and > icons can be used to move between pages.
',4);function V(C,Y){const n=r("ExternalLinkIcon"),s=r("RouterLink");return h(),l(p,null,[j,z,T,D,e("p",null,[R,e("a",x,[N,o(n)]),O]),B,e("p",null,[A,E,F,o(s,{to:"/register-organization.html"},{default:d(()=>[I]),_:1}),P]),L],64)}var H=c(S,[["render",V],["__file","navigation.html.vue"]]);export{H as default}; diff --git a/assets/navigation.html.7a922ae7.js b/assets/navigation.html.7a922ae7.js new file mode 100644 index 0000000..3355d39 --- /dev/null +++ b/assets/navigation.html.7a922ae7.js @@ -0,0 +1 @@ +const e={key:"v-123dff2c",path:"/navigation.html",title:"Navigating the RSD",lang:"en-US",frontmatter:{},excerpt:"",headers:[{level:2,title:"Global search",slug:"global-search",children:[]},{level:2,title:"Software Overview",slug:"software-overview",children:[]},{level:2,title:"Project Overview",slug:"project-overview",children:[]},{level:2,title:"Organization Overview",slug:"organization-overview",children:[]}],git:{updatedTime:1689773383e3,contributors:[{name:"Jason Maassen",email:"jmaassen73@gmail.com",commits:2},{name:"Ewan Cahen",email:"e.cahen@esciencecenter.nl",commits:1},{name:"Jesu\u0301s Garci\u0301a",email:"ctw@ctwhome.com",commits:1}]},filePathRelative:"navigation.md"};export{e as data}; diff --git a/assets/online-demo.html.74b86e3a.js b/assets/online-demo.html.74b86e3a.js new file mode 100644 index 0000000..f82f686 --- /dev/null +++ b/assets/online-demo.html.74b86e3a.js @@ -0,0 +1 @@ +import{_ as d,r as s,o as c,c as h,a as e,b as t,w as a,F as u,d as o,e as i}from"./app.60036ba8.js";import{_ as g}from"./plus-software-projects.0962d84b.js";import{_ as l}from"./my-software.fd5ba780.js";var p="/documentation/demo-sign-in.gif";const _={},m=e("h1",{id:"online-demo",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#online-demo","aria-hidden":"true"},"#"),o(" Online demo")],-1),f=e("p",null,"If you would like to experiment with adding content to the RSD yourself, your can use our online demo version at:",-1),w={href:"https://research-software.dev",target:"_blank",rel:"noopener noreferrer"},y=o("https://research-software.dev"),v=i('This online demo allows anyone to add software and projects for themselves. Please note that the data entered in this demo version is not curated in any way, and may be deleted at any time!
To get access to the online demo, click on "Sign in" at the top right. You will then get 3 options to sign in:
The most convenient way of signing in is using the "Local account" option. This option only requires a user name to sign in. No password is needed. We suggest using random user name, unrelated to your actual name.
Once you have signed in, you can use the "+" in the top right corner to add software or projects:
To get an overview of the software and projects you have added, click on the avatar icon at the top right:
Clicking on "My software", "My projects" or "My organizations" will take you to a profile page showing an overview of all pages you maintain. Once you have finished adding content, "Logout" can be used to sign out.
If you wish to officially add your organization to the RSD, or claim an organization which is already listed but not an official member yet, please contact the RSD administrators and clearly provide the following information:
We will then contact you to arrange access for your organization. Once your organization is registered, this will indicated by a verification checkmark on the card of your organization:
In the RSD, we interpret the term "organization" very broadly. Any organization involved in the development of research software should be able to join the RSD. Examples of organizations include (but are not limited to):
If you need to remove tag from the repository use following commands.
# delete locally
+git tag -d {tag}
+# remove from origin
+git push origin --delete {tag}
+# or more specifically
+git push origin :refs/tags/{tag}
+To sign in to the RSD, go to the "Sign in" button at the top right corner of the page and select the identity provider you wish to use:
If you sign in to the RSD for the first time, the identify provider may ask you permission to share information with the RSD.
TIP
Please contact us if you wish to use your ORCID to sign in to the RSD.
To sign in using ORCID, go to the "sign in" button at the top right corner of the page and select the ORCID identity provider. Next, enter your credentials on the ORCID sign in page that follows.
To sign out, you can use the profile button the top right corner of the page and select "Logout".
',4);function H(Y,M){const o=i("ExternalLinkIcon"),r=i("RouterLink");return h(),c(l,null,[_,p,t("ul",null,[t("li",null,[t("a",f,[b,n(o)])]),t("li",null,[t("a",m,[w,n(o)])])]),t("p",null,[y,n(r,{to:"/getting-access.html"},{default:d(()=>[R]),_:1}),x]),S,t("p",null,[t("a",D,[v,n(o)]),C,I,k]),t("div",O,[q,t("p",null,[F,t("a",T,[N,n(o)]),z])]),B,L,t("p",null,[t("a",U,[V,n(o)]),E]),P],64)}var G=a(g,[["render",H],["__file","sign-in.html.vue"]]);export{G as default}; diff --git a/assets/sign-in.html.f6076fdf.js b/assets/sign-in.html.f6076fdf.js new file mode 100644 index 0000000..526bb82 --- /dev/null +++ b/assets/sign-in.html.f6076fdf.js @@ -0,0 +1 @@ +const i={key:"v-5cc19c3d",path:"/sign-in.html",title:"Signing in",lang:"en-US",frontmatter:{},excerpt:"",headers:[{level:2,title:"How to sign in",slug:"how-to-sign-in",children:[{level:3,title:"Signing in with SURFConext",slug:"signing-in-with-surfconext",children:[]},{level:3,title:"Signing in with ORCID",slug:"signing-in-with-orcid",children:[]},{level:3,title:"Signing out",slug:"signing-out",children:[]}]}],git:{updatedTime:1668516783e3,contributors:[{name:"Jason Maassen",email:"jmaassen73@gmail.com",commits:3}]},filePathRelative:"sign-in.md"};export{i as data}; diff --git a/assets/style.1c9e494d.css b/assets/style.1c9e494d.css new file mode 100644 index 0000000..22b9e77 --- /dev/null +++ b/assets/style.1c9e494d.css @@ -0,0 +1 @@ +:root{--medium-zoom-z-index:100;--medium-zoom-bg-color:#ffffff;--medium-zoom-opacity:1}.medium-zoom-overlay{background-color:var(--medium-zoom-bg-color)!important;z-index:var(--medium-zoom-z-index)}.medium-zoom-overlay~img{z-index:calc(var(--medium-zoom-z-index) + 1)}.medium-zoom--opened .medium-zoom-overlay{opacity:var(--medium-zoom-opacity)}:root{--c-brand:#3eaf7c;--c-brand-light:#4abf8a}.back-to-top{--back-to-top-color:var(--c-brand);--back-to-top-color-hover:var(--c-brand-light)}.DocSearch{--docsearch-primary-color:var(--c-brand);--docsearch-text-color:var(--c-text);--docsearch-highlight-color:var(--c-brand);--docsearch-muted-color:var(--c-text-quote);--docsearch-container-background:rgba(9, 10, 17, .8);--docsearch-modal-background:var(--c-bg-light);--docsearch-searchbox-background:var(--c-bg-lighter);--docsearch-searchbox-focus-background:var(--c-bg);--docsearch-searchbox-shadow:inset 0 0 0 2px var(--c-brand);--docsearch-hit-color:var(--c-text-light);--docsearch-hit-active-color:var(--c-bg);--docsearch-hit-background:var(--c-bg);--docsearch-hit-shadow:0 1px 3px 0 var(--c-border-dark);--docsearch-footer-background:var(--c-bg)}.external-link-icon{--external-link-icon-color:var(--c-text-quote)}.medium-zoom-overlay{--medium-zoom-bg-color:var(--c-bg)}#nprogress{--nprogress-color:var(--c-brand)}.pwa-popup{--pwa-popup-text-color:var(--c-text);--pwa-popup-bg-color:var(--c-bg);--pwa-popup-border-color:var(--c-brand);--pwa-popup-shadow:0 4px 16px var(--c-brand);--pwa-popup-btn-text-color:var(--c-bg);--pwa-popup-btn-bg-color:var(--c-brand);--pwa-popup-btn-hover-bg-color:var(--c-brand-light)}.search-box{--search-bg-color:var(--c-bg);--search-accent-color:var(--c-brand);--search-text-color:var(--c-text);--search-border-color:var(--c-border);--search-item-text-color:var(--c-text-lighter);--search-item-focus-bg-color:var(--c-bg-light)}html.dark{--c-brand:#3aa675;--c-brand-light:#349469;--c-bg:#22272e;--c-bg-light:#2b313a;--c-bg-lighter:#262c34;--c-text:#adbac7;--c-text-light:#96a7b7;--c-text-lighter:#8b9eb0;--c-text-lightest:#8094a8;--c-border:#3e4c5a;--c-border-dark:#34404c;--c-tip:#318a62;color-scheme:dark;--c-brand:white;--c-brand-light:#ccc;--c-bg:#111;--c-bg-light:#393939;--c-bg-lighter:#555555;--c-text:#c7c7c7;--c-text-light:#bcbcbc;--c-text-lighter:#adadad;--c-text-lightest:#a7a8a8;--c-border:#595959;--c-border-dark:#464646;--c-tip:#7d7d7d;--c-warning:#ceab00;--c-warning-bg:#7e755b;--c-warning-title:#ceac03;--c-warning-text:#362e00;--c-danger:#940000;--c-danger-bg:#806161;--c-danger-title:#610000;--c-danger-text:#3a0000;--c-details-bg:#323843;--code-hl-bg-color:#363b46}html.dark .DocSearch{--docsearch-logo-color:var(--c-text);--docsearch-modal-shadow:inset 1px 1px 0 0 #2c2e40, 0 3px 8px 0 #000309;--docsearch-key-shadow:inset 0 -2px 0 0 #282d55, inset 0 0 1px 1px #51577d, 0 2px 2px 0 rgba(3, 4, 9, .3);--docsearch-key-gradient:linear-gradient(-225deg, #444950, #1c1e21);--docsearch-footer-shadow:inset 0 1px 0 0 rgba(73, 76, 106, .5), 0 -4px 8px 0 rgba(0, 0, 0, .2)}body,html{padding:0;margin:0;background-color:var(--c-bg);transition:background-color var(--t-color)}body{font-family:var(--font-family);-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-size:16px}a,p a code{color:var(--c-text-accent)}a{font-weight:500;text-decoration:none;overflow-wrap:break-word}p a code{font-weight:400}code,kbd{font-family:var(--font-family-code)}body,kbd{color:var(--c-text)}kbd{background:var(--c-bg-lighter);border:solid .15rem var(--c-border-dark);border-bottom:solid .25rem var(--c-border-dark);border-radius:.15rem;padding:0 .15em}code{color:var(--c-text-lighter);padding:.25rem .5rem;font-size:.85em;background-color:var(--c-bg-light);border-radius:3px;overflow-wrap:break-word;transition:background-color var(--t-color)}blockquote{font-size:1rem;color:var(--c-text-quote);border-left:.2rem solid var(--c-border-dark);margin:1rem 0;padding:.25rem 0 .25rem 1rem}blockquote>p,code{margin:0}ol,ul{padding-left:1.2em}strong{font-weight:600}h1,h2,h3,h4,h5,h6{font-weight:600;line-height:1.25}h1:focus-visible,h2:focus-visible,h3:focus-visible,h4:focus-visible,h5:focus-visible,h6:focus-visible{outline:0}h1:hover .header-anchor,h2:hover .header-anchor,h3:hover .header-anchor,h4:hover .header-anchor,h5:hover .header-anchor,h6:hover .header-anchor{opacity:1}h1{font-size:2.2rem}h2{font-size:1.65rem;padding-bottom:.3rem;border-bottom:1px solid var(--c-border);transition:border-color var(--t-color)}h3{font-size:1.35rem}h4{font-size:1.15rem}h5{font-size:1.05rem}h6{font-size:1rem}a.header-anchor{font-size:.85em;float:left;margin-left:-.87em;padding-right:.23em;margin-top:.125em;opacity:0}a.header-anchor:hover{text-decoration:none}a.header-anchor:focus-visible{opacity:1}ol,p,ul{line-height:1.7}hr{border:0;border-top:1px solid var(--c-border)}table,tr{transition:border-color var(--t-color)}table{border-collapse:collapse;margin:1rem 0;display:block;overflow-x:auto}tr{border-top:1px solid var(--c-border-dark)}tr:nth-child(2n){background-color:var(--c-bg-light);transition:background-color var(--t-color)}td,th{padding:.6em 1em;border:1px solid var(--c-border-dark);transition:border-color var(--t-color)}.arrow,.badge{display:inline-block}.arrow{width:0;height:0}.arrow.down,.arrow.up{border-left:4px solid transparent;border-right:4px solid transparent}.arrow.up{border-bottom:6px solid var(--c-bg-arrow)}.arrow.down{border-top:6px solid var(--c-bg-arrow)}.arrow.left,.arrow.right{border-top:4px solid transparent;border-bottom:4px solid transparent}.arrow.right{border-left:6px solid var(--c-bg-arrow)}.arrow.left{border-right:6px solid var(--c-bg-arrow)}.badge{font-size:14px;height:18px;line-height:18px;border-radius:3px;padding:0 6px;color:var(--c-bg);vertical-align:top;transition:color var(--t-color),background-color var(--t-color)}.badge.tip{background-color:var(--c-badge-tip)}.badge.warning{background-color:var(--c-badge-warning)}.badge.danger{background-color:var(--c-badge-danger)}.badge+.badge{margin-left:5px}code[class*=language-],pre[class*=language-]{color:#ccc;background:0 0;font-family:var(--font-family-code);font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#2d2d2d}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.block-comment,.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#999}.token.punctuation{color:#ccc}.token.attr-name,.token.deleted,.token.namespace,.token.tag{color:#ec5975}.token.function-name{color:#6196cc}.token.boolean,.token.function,.token.number{color:#f08d49}.token.class-name,.token.constant,.token.property,.token.symbol{color:#f8c555}.token.atrule,.token.builtin,.token.important,.token.keyword,.token.selector{color:#cc99cd}.token.attr-value,.token.char,.token.regex,.token.string,.token.variable{color:#7ec699}.token.entity,.token.operator,.token.url{color:#67cdcc}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:#3eaf7c}.theme-default-content pre,.theme-default-content pre[class*=language-]{line-height:1.4;padding:1.3rem 1.5rem;margin:.85rem 0;border-radius:6px;overflow:auto}.theme-default-content pre code,.theme-default-content pre[class*=language-] code{color:#fff;padding:0;background-color:transparent;border-radius:0;overflow-wrap:unset;-webkit-font-smoothing:auto;-moz-osx-font-smoothing:auto}.theme-default-content .line-number{font-family:var(--font-family-code)}div[class*=language-]{position:relative;background-color:var(--code-bg-color);border-radius:6px}div[class*=language-]:before{position:absolute;z-index:3;top:.8em;right:1em;font-size:.75rem;color:var(--code-ln-color)}div[class*=language-] pre,div[class*=language-] pre[class*=language-]{background:0 0!important;position:relative;z-index:1}div[class*=language-] .highlight-lines{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;padding-top:1.3rem;position:absolute;top:0;left:0;width:100%;line-height:1.4}div[class*=language-] .highlight-lines .highlight-line{background-color:var(--code-hl-bg-color)}div[class*=language-]:not(.line-numbers-mode) .line-numbers{display:none}div[class*=language-].line-numbers-mode .highlight-lines .highlight-line{position:relative}div[class*=language-].line-numbers-mode .highlight-lines .highlight-line:before{content:" ";position:absolute;z-index:2;left:0;top:0;display:block;width:var(--code-ln-wrapper-width);height:100%}div[class*=language-].line-numbers-mode pre{margin-left:var(--code-ln-wrapper-width);padding-left:1rem;vertical-align:middle}div[class*=language-].line-numbers-mode .line-numbers{position:absolute;top:0;width:var(--code-ln-wrapper-width);text-align:center;color:var(--code-ln-color);padding-top:1.25rem;line-height:1.4}div[class*=language-].line-numbers-mode .line-numbers .line-number,div[class*=language-].line-numbers-mode .line-numbers br{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}div[class*=language-].line-numbers-mode .line-numbers .line-number{position:relative;z-index:3;font-size:.85em;line-height:0}div[class*=language-].line-numbers-mode:after{content:"";position:absolute;top:0;left:0;width:var(--code-ln-wrapper-width);height:100%;border-radius:6px 0 0 6px;border-right:1px solid var(--code-hl-bg-color)}div[class*=language-].ext-c:before{content:"c"}div[class*=language-].ext-cpp:before{content:"cpp"}div[class*=language-].ext-cs:before{content:"cs"}div[class*=language-].ext-css:before{content:"css"}div[class*=language-].ext-dart:before{content:"dart"}div[class*=language-].ext-docker:before{content:"docker"}div[class*=language-].ext-fs:before{content:"fs"}div[class*=language-].ext-go:before{content:"go"}div[class*=language-].ext-html:before{content:"html"}div[class*=language-].ext-java:before{content:"java"}div[class*=language-].ext-js:before{content:"js"}div[class*=language-].ext-json:before{content:"json"}div[class*=language-].ext-kt:before{content:"kt"}div[class*=language-].ext-less:before{content:"less"}div[class*=language-].ext-makefile:before{content:"makefile"}div[class*=language-].ext-md:before{content:"md"}div[class*=language-].ext-php:before{content:"php"}div[class*=language-].ext-py:before{content:"py"}div[class*=language-].ext-rb:before{content:"rb"}div[class*=language-].ext-rs:before{content:"rs"}div[class*=language-].ext-sass:before{content:"sass"}div[class*=language-].ext-scss:before{content:"scss"}div[class*=language-].ext-sh:before{content:"sh"}div[class*=language-].ext-styl:before{content:"styl"}div[class*=language-].ext-ts:before{content:"ts"}div[class*=language-].ext-toml:before{content:"toml"}div[class*=language-].ext-vue:before{content:"vue"}div[class*=language-].ext-yml:before{content:"yml"}@media (max-width:419px){.theme-default-content div[class*=language-]{margin:.85rem -1.5rem;border-radius:0}}.code-group__nav{margin-top:.85rem;margin-bottom:calc(-1.7rem - 6px);padding-bottom:calc(1.7rem - 6px);padding-left:10px;padding-top:10px;border-top-left-radius:6px;border-top-right-radius:6px;background-color:var(--code-bg-color)}.code-group__ul{margin:auto 0;padding-left:0;display:inline-flex;list-style:none}.code-group__nav-tab{border:0;padding:5px;cursor:pointer;background-color:transparent;font-size:.85em;line-height:1.4;color:#ffffffe6;font-weight:600}.code-group__nav-tab:focus{outline:0}.code-group__nav-tab:focus-visible{outline:1px solid rgba(255,255,255,.9)}.code-group__nav-tab-active{border-bottom:var(--c-brand) 1px solid}@media (max-width:419px){.code-group__nav{margin-left:-1.5rem;margin-right:-1.5rem;border-radius:0}}.code-group-item,.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>a.router-link-active:after{display:none}.code-group-item__active{display:block}.code-group-item>pre{background-color:orange}.custom-container{transition:color var(--t-color),border-color var(--t-color),background-color var(--t-color)}.custom-container .custom-container-title{font-weight:600}.custom-container .custom-container-title:not(:only-child){margin-bottom:-.4rem}.custom-container.danger,.custom-container.tip,.custom-container.warning{padding:.1rem 1.5rem;border-left-width:.5rem;border-left-style:solid;margin:1rem 0}.custom-container.tip{border-color:var(--c-tip);background-color:var(--c-tip-bg);color:var(--c-tip-text)}.custom-container.tip .custom-container-title{color:var(--c-tip-title)}.custom-container.tip a{color:var(--c-tip-text-accent)}.custom-container.warning{border-color:var(--c-warning);background-color:var(--c-warning-bg);color:var(--c-warning-text)}.custom-container.warning .custom-container-title{color:var(--c-warning-title)}.custom-container.warning a{color:var(--c-warning-text-accent)}.custom-container.danger{border-color:var(--c-danger);background-color:var(--c-danger-bg);color:var(--c-danger-text)}.custom-container.danger .custom-container-title{color:var(--c-danger-title)}.custom-container.danger a{color:var(--c-danger-text-accent)}.custom-container.details{display:block;position:relative;border-radius:2px;margin:1.6em 0;padding:1.6em;background-color:var(--c-details-bg)}.custom-container.details h4{margin-top:0}.custom-container.details figure:last-child,.custom-container.details p:last-child{margin-bottom:0;padding-bottom:0}.custom-container.details summary{outline:0;cursor:pointer}.home{padding:var(--navbar-height) 2rem 0;max-width:var(--homepage-width);margin:0 auto;display:block}.home .hero{text-align:center}.home .hero img{max-width:100%;max-height:280px;display:block;margin:3rem auto 1.5rem}.home .hero h1{font-size:3rem}.home .hero .actions,.home .hero .description,.home .hero h1{margin:1.8rem auto}.home .hero .actions{display:flex;flex-wrap:wrap;gap:1rem;justify-content:center}.home .hero .description{max-width:35rem;font-size:1.6rem;line-height:1.3;color:var(--c-text-lightest)}.home .hero .action-button{display:inline-block;font-size:1.2rem;padding:.8rem 1.6rem;border-width:2px;border-style:solid;border-radius:4px;transition:background-color var(--t-color);box-sizing:border-box}.home .hero .action-button.primary{color:var(--c-bg);background-color:var(--c-brand);border-color:var(--c-brand)}.home .hero .action-button.primary:hover{background-color:var(--c-brand-light)}.home .hero .action-button.secondary{color:var(--c-brand);background-color:var(--c-bg);border-color:var(--c-brand)}.home .hero .action-button.secondary:hover{color:var(--c-bg);background-color:var(--c-brand-light)}.home .features{border-top:1px solid var(--c-border);transition:border-color var(--t-color);padding:1.2rem 0;margin-top:2.5rem;display:flex;flex-wrap:wrap;align-items:flex-start;align-content:stretch;justify-content:space-between}.home .feature{flex-grow:1;flex-basis:30%;max-width:30%}.home .feature h2{font-size:1.4rem;font-weight:500;border-bottom:none;padding-bottom:0;color:var(--c-text-light)}.home .feature p,.home .footer{color:var(--c-text-lighter)}.home .footer{padding:2.5rem;border-top:1px solid var(--c-border);text-align:center;transition:border-color var(--t-color)}@media (max-width:719px){.home .features{flex-direction:column}.home .feature{max-width:100%;padding:0 2.5rem}}@media (max-width:419px){.home{padding-left:1.5rem;padding-right:1.5rem}.home .hero img{max-height:210px;margin:2rem auto 1.2rem}.home .hero h1{font-size:2rem}.home .hero .actions,.home .hero .description,.home .hero h1{margin:1.2rem auto}.home .hero .description{font-size:1.2rem}.home .hero .action-button{font-size:1rem;padding:.6rem 1.2rem}.home .feature h2{font-size:1.25rem}}.page{padding-top:var(--navbar-height);padding-left:var(--sidebar-width)}.navbar,.sidebar{position:fixed;left:0;box-sizing:border-box}.navbar{z-index:20;top:0;right:0;height:var(--navbar-height);border-bottom:1px solid var(--c-border);background-color:var(--c-bg-navbar);transition:background-color var(--t-color),border-color var(--t-color)}.sidebar{font-size:16px;width:var(--sidebar-width);z-index:10;margin:0;top:var(--navbar-height);bottom:0;border-right:1px solid var(--c-border);overflow-y:auto;scrollbar-width:thin;scrollbar-color:var(--c-brand) var(--c-border);background-color:var(--c-bg-sidebar);transition:transform var(--t-transform),background-color var(--t-color),border-color var(--t-color)}.sidebar::-webkit-scrollbar{width:7px}.sidebar::-webkit-scrollbar-track{background-color:var(--c-border)}.sidebar::-webkit-scrollbar-thumb{background-color:var(--c-brand)}.sidebar-mask{position:fixed;z-index:9;top:0;left:0;width:100vw;height:100vh;display:none}.theme-container.sidebar-open .sidebar-mask{display:block}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(1){transform:rotate(45deg) translate3d(5.5px,5.5px,0)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(2){transform:scale3d(0,1,1)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(3){transform:rotate(-45deg) translate3d(6px,-6px,0)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(1),.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(3){transform-origin:center}.theme-container.no-navbar .theme-default-content:not(.custom)>h1,.theme-container.no-navbar h2,.theme-container.no-navbar h3,.theme-container.no-navbar h4,.theme-container.no-navbar h5,.theme-container.no-navbar h6{margin-top:1.5rem;padding-top:0}.theme-container.no-navbar .page{padding-top:0}.theme-container.no-navbar .sidebar{top:0}@media (min-width:720px){.theme-container.no-sidebar .sidebar{display:none}.theme-container.no-sidebar .page{padding-left:0}}.theme-default-content:not(.custom)>h1,.theme-default-content:not(.custom)>h2,.theme-default-content:not(.custom)>h3,.theme-default-content:not(.custom)>h4,.theme-default-content:not(.custom)>h5,.theme-default-content:not(.custom)>h6{margin-top:calc(.5rem - var(--navbar-height));padding-top:calc(1rem + var(--navbar-height));margin-bottom:0}.theme-default-content:not(.custom)>h1:first-child,.theme-default-content:not(.custom)>h2:first-child,.theme-default-content:not(.custom)>h3:first-child,.theme-default-content:not(.custom)>h4:first-child,.theme-default-content:not(.custom)>h5:first-child,.theme-default-content:not(.custom)>h6:first-child{margin-bottom:1rem}.theme-default-content:not(.custom)>h1:first-child+.custom-container,.theme-default-content:not(.custom)>h1:first-child+p,.theme-default-content:not(.custom)>h1:first-child+pre,.theme-default-content:not(.custom)>h2:first-child+.custom-container,.theme-default-content:not(.custom)>h2:first-child+p,.theme-default-content:not(.custom)>h2:first-child+pre,.theme-default-content:not(.custom)>h3:first-child+.custom-container,.theme-default-content:not(.custom)>h3:first-child+p,.theme-default-content:not(.custom)>h3:first-child+pre,.theme-default-content:not(.custom)>h4:first-child+.custom-container,.theme-default-content:not(.custom)>h4:first-child+p,.theme-default-content:not(.custom)>h4:first-child+pre,.theme-default-content:not(.custom)>h5:first-child+.custom-container,.theme-default-content:not(.custom)>h5:first-child+p,.theme-default-content:not(.custom)>h5:first-child+pre,.theme-default-content:not(.custom)>h6:first-child+.custom-container,.theme-default-content:not(.custom)>h6:first-child+p,.theme-default-content:not(.custom)>h6:first-child+pre{margin-top:2rem}.theme-default-content:not(.custom){max-width:var(--content-width);margin:0 auto;padding:2rem 2.5rem;padding-top:0}@media (max-width:959px){.theme-default-content:not(.custom){padding:2rem}}@media (max-width:419px){.theme-default-content:not(.custom){padding:1.5rem}}.theme-default-content:not(.custom) a:hover{text-decoration:underline}.theme-default-content:not(.custom) img{max-width:100%}.theme-default-content.custom{padding:0;margin:0}.theme-default-content.custom img{max-width:100%}@media (max-width:959px){.sidebar{font-size:15px;width:var(--sidebar-width-mobile)}.page{padding-left:var(--sidebar-width-mobile)}}@media (max-width:719px){.sidebar{top:0;padding-top:var(--navbar-height);transform:translate(-100%)}.page{padding-left:0}.theme-container.sidebar-open .sidebar{transform:translate(0)}.theme-container.no-navbar .sidebar{padding-top:0}}@media (max-width:419px){h1{font-size:1.9rem}}.navbar{--navbar-line-height:calc( var(--navbar-height) - 2 * var(--navbar-padding-v) );padding:var(--navbar-padding-v) var(--navbar-padding-h);line-height:var(--navbar-line-height)}.navbar .logo{height:var(--navbar-line-height);margin-right:var(--navbar-padding-v);vertical-align:top}.navbar .site-name{font-size:1.3rem;font-weight:600;color:var(--c-text);position:relative}.navbar .navbar-items-wrapper{display:flex;position:absolute;box-sizing:border-box;top:var(--navbar-padding-v);right:var(--navbar-padding-h);height:var(--navbar-line-height);padding-left:var(--navbar-padding-h);white-space:nowrap;font-size:.9rem}.navbar .navbar-items-wrapper .search-box{flex:0 0 auto;vertical-align:top}@media (max-width:719px){.navbar{padding-left:4rem}.navbar .can-hide{display:none}.navbar .site-name{width:calc(100vw - 9.4rem);overflow:hidden;white-space:nowrap;text-overflow:ellipsis}}.navbar-items,.navbar-items a{display:inline-block}.navbar-items a{line-height:1.4rem;color:inherit}.navbar-items a.router-link-active,.navbar-items a:hover{color:var(--c-text-accent)}.navbar-items .navbar-item{position:relative;display:inline-block;margin-left:1.5rem;line-height:var(--navbar-line-height)}.navbar-items .navbar-item:first-child{margin-left:0}@media (max-width:719px){.navbar-items .navbar-item{margin-left:0}}@media (min-width:719px){.navbar-items a.router-link-active,.navbar-items a:hover{color:var(--c-text)}.navbar-item>a.router-link-active,.navbar-item>a:hover{margin-bottom:-2px;border-bottom:2px solid var(--c-text-accent)}}.toggle-sidebar-button{position:absolute;top:.6rem;left:1rem;display:none;padding:.6rem;cursor:pointer}.toggle-sidebar-button .icon{display:flex;flex-direction:column;justify-content:center;align-items:center;width:1.25rem;height:1.25rem;cursor:inherit}.toggle-sidebar-button .icon span{display:inline-block;width:100%;height:2px;border-radius:2px;background-color:var(--c-text);transition:transform var(--t-transform)}.toggle-sidebar-button .icon span:nth-child(2){margin:6px 0}@media screen and (max-width:719px){.toggle-sidebar-button{display:block}}.toggle-dark-button{display:flex;margin:auto;margin-left:1rem;border:0;background:0 0;color:var(--c-text);opacity:.8;cursor:pointer}.toggle-dark-button:hover{opacity:1}.toggle-dark-button .icon{width:1.25rem;height:1.25rem}.DocSearch{transition:background-color var(--t-color)}.navbar-dropdown-wrapper{cursor:pointer}.navbar-dropdown-wrapper .navbar-dropdown-title,.navbar-dropdown-wrapper .navbar-dropdown-title-mobile{display:block;font-size:.9rem;font-family:inherit;cursor:inherit;padding:inherit;line-height:1.4rem;background:0 0;border:0;font-weight:500;color:var(--c-text)}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile{display:none;font-weight:600;font-size:inherit}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile:hover,.navbar-dropdown-wrapper .navbar-dropdown-title:hover{border-color:transparent}.navbar-dropdown-wrapper .navbar-dropdown-title .arrow,.navbar-dropdown-wrapper .navbar-dropdown-title-mobile .arrow{vertical-align:middle;margin-top:-1px;margin-left:.4rem}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile:hover{color:var(--c-text-accent)}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item{color:inherit;line-height:1.7rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle{margin:.45rem 0 0;border-top:1px solid var(--c-border);padding:1rem 0 .45rem;font-size:.9rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>span{padding:0 1.5rem 0 1.25rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>a{font-weight:inherit}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem-wrapper{padding:0;list-style:none}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem-wrapper .navbar-dropdown-subitem{font-size:.9em}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a{display:block;line-height:1.7rem;position:relative;border-bottom:none;font-weight:400;margin-bottom:0;padding:0 1.5rem 0 1.25rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active,.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a:hover{color:var(--c-text-accent)}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active:after{content:"";width:0;height:0;border-left:5px solid var(--c-text-accent);border-top:3px solid transparent;border-bottom:3px solid transparent;position:absolute;top:calc(50% - 2px);left:9px}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item:first-child .navbar-dropdown-subtitle{margin-top:0;padding-top:0;border-top:0}@media (max-width:719px){.navbar-dropdown-wrapper.open .navbar-dropdown-title,.navbar-dropdown-wrapper.open .navbar-dropdown-title-mobile{margin-bottom:.5rem}.navbar-dropdown-wrapper .navbar-dropdown-title{display:none}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile{display:block}.navbar-dropdown-wrapper .navbar-dropdown{transition:height .1s ease-out;overflow:hidden}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle{border-top:0;margin-top:0;padding-top:0;padding-bottom:0;font-size:15px;line-height:2rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item>a{font-size:15px;line-height:2rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem{font-size:14px;padding-left:1rem}}@media (min-width:720px){.navbar-dropdown-wrapper{height:1.8rem}.navbar-dropdown-wrapper.open .navbar-dropdown,.navbar-dropdown-wrapper:hover .navbar-dropdown{display:block!important}.navbar-dropdown-wrapper.open:blur{display:none}.navbar-dropdown-wrapper .navbar-dropdown{display:none;height:auto!important;box-sizing:border-box;max-height:calc(100vh - 2.7rem);overflow-y:auto;position:absolute;top:100%;right:0;background-color:var(--c-bg-navbar);padding:.6rem 0;border:1px solid var(--c-border);border-bottom-color:var(--c-border-dark);text-align:left;border-radius:.25rem;white-space:nowrap;margin:0}}.page{padding-bottom:2rem;display:block}.page-meta{max-width:var(--content-width);margin:0 auto;padding:1rem 2.5rem;overflow:auto}@media (max-width:959px){.page-meta{padding:2rem}}@media (max-width:419px){.page-meta{padding:1.5rem}}.page-meta .meta-item{cursor:default;margin-top:.8rem}.page-meta .meta-item .meta-item-label{font-weight:500;color:var(--c-text-lighter)}.page-meta .meta-item .meta-item-info{font-weight:400;color:var(--c-text-quote)}.page-meta .edit-link{display:inline-block;margin-right:.25rem}.page-meta .last-updated{float:right}@media (max-width:719px){.page-meta .last-updated{font-size:.8em;float:none}.page-meta .contributors{font-size:.8em}}.page-nav{max-width:var(--content-width);margin:0 auto;padding:1rem 2.5rem 2rem;padding-bottom:0}@media (max-width:959px){.page-nav{padding:2rem}}@media (max-width:419px){.page-nav{padding:1.5rem}}.page-nav .inner{min-height:2rem;margin-top:0;border-top:1px solid var(--c-border);transition:border-color var(--t-color);padding-top:1rem;overflow:auto}.page-nav .prev a:before{content:"\2190"}.page-nav .next{float:right}.page-nav .next a:after{content:"\2192"}.sidebar ul{padding:0;margin:0;list-style-type:none}.sidebar a{display:inline-block}.sidebar .navbar-items{display:none;border-bottom:1px solid var(--c-border);transition:border-color var(--t-color);padding:.5rem 0 .75rem}.sidebar .navbar-items a{font-weight:600}.sidebar .navbar-items .navbar-item{display:block;line-height:1.25rem;font-size:1.1em;padding:.5rem 0 .5rem 1.5rem}.sidebar .sidebar-items{padding:1.5rem 0}@media (max-width:719px){.sidebar .navbar-items{display:block}.sidebar .navbar-items .navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active:after{top:calc(1rem - 2px)}.sidebar .sidebar-items{padding:1rem 0}}.sidebar-item{cursor:default;border-left:.25rem solid transparent;color:var(--c-text)}.sidebar-item:focus-visible{outline-width:1px;outline-offset:-1px}.sidebar-item.active:not(p.sidebar-heading){font-weight:600;color:var(--c-text-accent);border-left-color:var(--c-text-accent)}.sidebar-item.sidebar-heading{transition:color .15s ease;font-size:1.1em;font-weight:700;padding:.35rem 1.5rem .35rem 1.25rem;width:100%;box-sizing:border-box;margin:0}.sidebar-item.sidebar-heading.collapsible,a.sidebar-item{cursor:pointer}.sidebar-item.sidebar-heading.collapsible+.sidebar-item-children{transition:height .1s ease-out;overflow:hidden;margin-bottom:.75rem}.sidebar-item.sidebar-heading .arrow{position:relative;top:-.12em;left:.5em}.sidebar-item:not(.sidebar-heading){font-size:1em;font-weight:400;display:inline-block;margin:0;padding:.35rem 1rem .35rem 2rem;line-height:1.4;width:100%;box-sizing:border-box}.sidebar-item:not(.sidebar-heading)+.sidebar-item-children{padding-left:1rem;font-size:.95em}.sidebar-item-children .sidebar-item-children .sidebar-item:not(.sidebar-heading){padding:.25rem 1rem .25rem 1.75rem}.sidebar-item-children .sidebar-item-children .sidebar-item:not(.sidebar-heading).active{font-weight:500;border-left-color:transparent}a.sidebar-heading+.sidebar-item-children .sidebar-item:not(.sidebar-heading).active{border-left-color:transparent}a.sidebar-item:hover{color:var(--c-text-accent)}.table-of-contents .badge{vertical-align:middle}.dropdown-enter-from,.dropdown-leave-to{height:0!important}.fade-slide-y-enter-active{transition:all .2s ease}.fade-slide-y-leave-active{transition:all .2s cubic-bezier(1,.5,.8,1)}.fade-slide-y-enter-from,.fade-slide-y-leave-to{transform:translateY(10px);opacity:0}:root{--c-brand:black;--c-brand-light:#bf4a4a;--c-bg:#ffffff;--c-bg-light:#f3f4f5;--c-bg-lighter:#eeeeee;--c-bg-navbar:var(--c-bg);--c-bg-sidebar:var(--c-bg);--c-bg-arrow:#cccccc;--c-text:#2c3e50;--c-text-accent:var(--c-brand);--c-text-light:#3a5169;--c-text-lighter:#4e6e8e;--c-text-lightest:#6a8bad;--c-text-quote:#999999;--c-border:#eaecef;--c-border-dark:#dfe2e5;--c-tip:#42b983;--c-tip-bg:var(--c-bg-light);--c-tip-title:var(--c-text);--c-tip-text:var(--c-text);--c-tip-text-accent:var(--c-text-accent);--c-warning:#e7c000;--c-warning-bg:#fffae3;--c-warning-title:#ad9000;--c-warning-text:#746000;--c-warning-text-accent:var(--c-text);--c-danger:#cc0000;--c-danger-bg:#ffe0e0;--c-danger-title:#990000;--c-danger-text:#660000;--c-danger-text-accent:var(--c-text);--c-details-bg:#eeeeee;--c-badge-tip:var(--c-tip);--c-badge-warning:var(--c-warning);--c-badge-danger:var(--c-danger);--t-color:.3s ease;--t-transform:.3s ease;--code-bg-color:#282c34;--code-hl-bg-color:rgba(0, 0, 0, .66);--code-ln-color:#9e9e9e;--code-ln-wrapper-width:3.5rem;--font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;--font-family-code:Consolas, Monaco, "Andale Mono", "Ubuntu Mono", monospace;--navbar-height:3.6rem;--navbar-padding-v:.7rem;--navbar-padding-h:1.5rem;--sidebar-width:20rem;--sidebar-width-mobile:calc(var(--sidebar-width) * .82);--content-width:740px;--homepage-width:960px}header.hero{margin-bottom:100px!important}header.hero img{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-user-drag:none;-khtml-user-drag:none;-moz-user-drag:none;-o-user-drag:none;margin:0 auto -100px!important;height:auto!important;max-height:370px!important}header.hero h1{margin:50px auto!important}:root{--external-link-icon-color:#aaa}.external-link-icon{position:relative;display:inline-block;color:var(--external-link-icon-color);vertical-align:middle;top:-1px}.external-link-icon-sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border-width:0;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}:root{--search-bg-color:#ffffff;--search-accent-color:#3eaf7c;--search-text-color:#2c3e50;--search-border-color:#eaecef;--search-item-text-color:#5d81a5;--search-item-focus-bg-color:#f3f4f5;--search-input-width:8rem;--search-result-width:20rem}.search-box{display:inline-block;position:relative;margin-left:1rem}.search-box input{cursor:text;width:var(--search-input-width);height:2rem;color:var(--search-text-color);display:inline-block;border:1px solid var(--search-border-color);border-radius:2rem;font-size:.9rem;line-height:2rem;padding:0 .5rem 0 2rem;outline:0;transition:all ease .3s;background:var(--search-bg-color)url(/documentation/assets/search.0782d0d1.svg).6rem .5rem no-repeat;background-size:1rem}.search-box input:focus{cursor:auto;border-color:var(--search-accent-color)}.search-box .suggestions{background:var(--search-bg-color);width:var(--search-result-width);position:absolute;top:2rem;right:0;border:1px solid var(--search-border-color);border-radius:6px;padding:.4rem;list-style-type:none}.search-box .suggestion{line-height:1.4;padding:.4rem .6rem;border-radius:4px;cursor:pointer}.search-box .suggestion.focus{background-color:var(--search-item-focus-bg-color)}.search-box .suggestion.focus a{color:var(--search-accent-color)}.search-box .suggestion a{white-space:normal;color:var(--search-item-text-color)}.search-box .suggestion .page-title{font-weight:600}.search-box .suggestion .page-header{font-size:.9em;margin-left:.25em}@media (max-width:720px){.search-box input{cursor:pointer;width:0;border-color:transparent;position:relative}.search-box input:focus{cursor:text;left:0;width:10rem}}@media (max-width:420px){.search-box input:focus{width:8rem}.search-box .suggestions{width:calc(100vw - 4rem);right:-.5rem}}:root{--back-to-top-z-index:5;--back-to-top-color:#3eaf7c;--back-to-top-color-hover:#71cda3}.back-to-top{cursor:pointer;position:fixed;bottom:2rem;right:2.5rem;width:2rem;height:1.2rem;background-color:var(--back-to-top-color);-webkit-mask:url(/documentation/assets/back-to-top.8efcbe56.svg)no-repeat;mask:url(/documentation/assets/back-to-top.8efcbe56.svg)no-repeat;z-index:var(--back-to-top-z-index)}.back-to-top:hover{background-color:var(--back-to-top-color-hover)}@media (max-width:959px){.back-to-top{display:none}}.back-to-top-enter-active,.back-to-top-leave-active{transition:opacity .3s}.back-to-top-enter-from,.back-to-top-leave-to{opacity:0}:root{--nprogress-color:#29d;--nprogress-z-index:1031}#nprogress{pointer-events:none}#nprogress .bar{background:var(--nprogress-color);position:fixed;z-index:var(--nprogress-z-index);top:0;left:0;width:100%;height:2px}#nprogress .peg{display:block;position:absolute;right:0;width:100px;height:100%;box-shadow:0 0 10px var(--nprogress-color),0 0 5px var(--nprogress-color);opacity:1;transform:rotate(3deg) translateY(-4px)} diff --git a/assets/user-guide.html.63d35200.js b/assets/user-guide.html.63d35200.js new file mode 100644 index 0000000..9d8eeb9 --- /dev/null +++ b/assets/user-guide.html.63d35200.js @@ -0,0 +1 @@ +const e={key:"v-144de286",path:"/user-guide.html",title:"User Guide",lang:"en-US",frontmatter:{},excerpt:"",headers:[{level:2,title:"Software Packages",slug:"software-packages",children:[]},{level:2,title:"Projects",slug:"projects",children:[]},{level:2,title:"Organizations",slug:"organizations",children:[]}],git:{updatedTime:1657095699e3,contributors:[{name:"Jesu\u0301s Garci\u0301a",email:"ctw@ctwhome.com",commits:1}]},filePathRelative:"user-guide.md"};export{e as data}; diff --git a/assets/user-guide.html.bd6768f8.js b/assets/user-guide.html.bd6768f8.js new file mode 100644 index 0000000..957eb34 --- /dev/null +++ b/assets/user-guide.html.bd6768f8.js @@ -0,0 +1 @@ +import{_ as e,e as a}from"./app.60036ba8.js";const r={},i=a('Documentation in progress.
RSD DocumentationWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our community include:
Examples of unacceptable behavior include:
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rsd@esciencecenter.nl All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
RSD Documentation👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to the Research Software Directory (as a Service), which is hosted on GitHub.
These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document.
We welcome any kind of contribution to our software, from simple comments or questions to a full-fledged pull request.
Help us keep the Research Software Directory open and inclusive. Please read and follow our Code of Conduct.
A contribution can be one of the following cases:
The sections below outline the steps in each case.
For general questions (not directly related to the development of the software) you can send an email to rsd@esciencecenter.nl. Alternatively, you can also submit an issue:
If you find a bug or experience unexpected behavior, you can submit an issue:
To request a feature you can submit an issue on GitHub. Please keep in mind that our development resources are limited, so we may not be able to honor your request.
Contributions to the code base are very welcome. Keep in mind, however, that this also requires a good interaction with the community to ensure that your contribution is adopted.
In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request (have a look at some of our old pull requests to see how this works.
Contributions to the code are by no means the only way to contribute to the Research Software Directory. If you wish to contribute in some other way, please contact us at rsd@esciencecenter.nl.
RSD DocumentationThis feature allows you to embed the RSD Software and Projects as an IFrame in your website. The Header and the Footer are automatically hidden and users will be able to navigate between the main list and the document.
Html test page: Test: https://www.research-software.dev/embed_example.html
<h2>Check our Software - Demo Embed pages</h2>
+<iframe src="http://localhost/software?embed" title="RSD Software" width="100%" height="500" frameBorder="0"></iframe>
+
+<h2>Check our Projects - Demo Embed pages</h2>
+<iframe src="http://localhost/projects?embed" title="RSD Software" width="100%" height="500" frameBorder="0"></iframe>
+No questions yet!
RSD DocumentationWhile anyone is free to browse through the content of the RSD, you'll need to be able to sign in before you can add our own content. Currently, there are two ways to get access:
If you wish to add your organization to the RSD or claim an organization which is already listed, please have a look at how to Register an organization.
ORCID is the Open Research and Contributor ID. It provides a unique, persistent identifier for researchers and is widely used to identify their contributions to research outputs (such as publications, software, data, etc.). You can use your ORCID account to get access to the RSD. However, since anyone is free to create an ORCID, we only enable ORCID sign-in on request.
TIP
Please contact us if you wish to use ORCID to sign in to the RSD and provide the following information:
We will then contact you to arrange access. Once your ORCID sign in is enabled, an RSD account is created automatically the first time you sign in.
SurfConext is an identity provider for Dutch research and education institutions. It can be used by employees of member organizations to sign in to the RSD using their institute credentials. You can check if your organization in on the list of SURFConext members. Before you can use SURFConext to sign in, your organization must enable the RSD service in their SURFconext dashboard.
TIP
You can check here if your organization has enabled the RSD service in SURFConext.
If your organization is has not enabled the RSD service yet, please contact your local SURFConext representative, and ask them to contact us via the RSD administrators email. In the mean time you may use the ORCID sign in described above as an alternative.
Once your organization has enabled the RSD service in SURFConext, you should be able to sign in to the RSD using your institute credentials. An RSD account is created automatically the first time you sign in.
To sign in to the RSD, go to the "Sign in" button at the top right corner of the page and select the identity provider you wish to use:
Next, you will be redirected to a login page of the selected identity provider. After providing you credentials you will return to the RSD page you came from. If you sign in to the RSD for the first time, the identify provider may ask you permission to share information with the RSD.
To sign out, you can use the profile button the top right corner of the page and select "Logout":
RSD DocumentationTEST
The Research Software Directory can be found at:
https://research-software-directory.org/
On this page you will find links to the research software recorded in the RSD, the research projects in which this software was used or developed, and the organizations who contributed to this software.
All information recorded in the RSD about software, projects and organizations is public, since our goal is to show the impact and promote the visibility and reuse of research software. Anyone can browse through this information and it is indexed by search engines.
RSD DocumentationHow to get access How to register organizations Documentation FAQ
RSD DocumentationWelcome to the user documentation of the Research Software Directory!
Research software is one of the most important scientific instruments available today. Data-intensive research and computational simulation are the foundation of many scientific discoveries.
The Research Software Directory (RSD) is a free online platform designed to showcase the impact of research software on research and society. By showing research software together with relevant contextual information such as scientific publications, contributors, projects, citation information and much more, we stimulate thereuse and encourage proper citation to ensure the researchers and RSEs developing the software get credit for their work.
More information about the concepts behind the RSD can be found in this excellent blog.
The Research Software Directory was initiated in 2017 by the Netherlands eScience Center as a platform to showcase the research software developed at our center. After sucessfully using the RSD for several years, we decided in 2021 to re-engineer the platform so we can offer it as an online service to other research organizations. In 2022, our development effort was joined by HIFIS.
RSD Documentation
There are many ways to discover interesting research software on the RSD. The main starting points are:
For more advanced users, we also offer a REST API, allowing you to use the RSD as a data source for other applications.
Using the search bar in the header, you can perform a global search of all data in the RSD by simply providing a search term. Currently, the search will match the following fields:
At the moment, we do not yet match on the long descriptions of software, projects and organizations, but we expect to do so in the future.
The software overview page provides a list of all software in the RSD. For each software, a card is shown with basic information: name, short description, last update, number of mentions, and number of contributors. To browse and search for software of interest, the filter and search bar on the top of the page can be used:
Simply typing into the search bar will trigger the RSD to search for software containing (part of) the terms you entered. The name, short description and keywords are included in the search. Entering multiple words into the search bar will be interpreted as an AND. Only software containing all search terms will be shown as a result.
By default, 12 software cards are shown per page. This number can be increased if desired using the Per page dropdown menu. The < and > icons can be used to move between pages.
It is also possible to filter the software by keywords. By clicking the filter icon 
a filter popup will appear allowing you to select (or type) one or more keywords used by software in the RSD:
Selecting multiple keywords is interpreted as an AND. Only software using all of the selected keywords will be shown as a result. You can also combine the keyword filters with search terms to further reduce the selection.
The project overview page provides a list of all projects in the RSD. For each project, a card is shown with basic information: name, short description, last update, and if the project is running or completed. To browse and search for projects of interest, the filter and search bar on the top of the page can be used:
Simply typing into the search bar will trigger the RSD to search for projects containing (part of) the terms you entered. The name, short description, keywords, and research domains are included in the search. Entering multiple words into the search bar will be interpreted as an AND. Only projects containing all search terms will be shown as a result.
By default, 12 project cards are shown per page. This number can be increased if desired using the Per page dropdown menu. The < and > icons can be used to move between pages.
It is also possible to filter the projects by keywords and/or research domains. By clicking the filter icon a filter popup will appear allowing you to select (or type) one or more keywords and research domains used by projects in the RSD:
Selecting multiple keywords and research domains is interpreted as an AND. Only software using all of the selected keywords and research domains will be shown as a result. You can also combine the keyword filters with search terms to further reduce the selection.
The organization overview page provides a list of all organizations listed in the RSD. For each organization, a card is shown basic information: name, logo, and the number of software and project pages which this organization participates in.
For organizations which are a registered member of the RSD, the 
checkmark is shown on the card. If you wish to register your organization, you can find more information in How to register an organization.
To browse and search for organizations of interest, the search bar on the top of the page can be used:
Simply typing into the search bar will trigger the RSD to search for organization whose name contains (part of) the terms you entered. Entering multiple words into the search bar will be interpreted as an AND. Only organizations whose name contains all search terms will be shown as a result.
By default, 12 organization cards are shown per page. This number can be increased if desired using the Per page dropdown menu. The < and > icons can be used to move between pages.
RSD DocumentationIf you would like to experiment with adding content to the RSD yourself, your can use our online demo version at:
This online demo allows anyone to add software and projects for themselves. Please note that the data entered in this demo version is not curated in any way, and may be deleted at any time!
To get access to the online demo, click on "Sign in" at the top right. You will then get 3 options to sign in:
The most convenient way of signing in is using the "Local account" option. This option only requires a user name to sign in. No password is needed. We suggest using random user name, unrelated to your actual name.
Once you have signed in, you can use the "+" in the top right corner to add software or projects:
You can find more information in the rest of this documentation on how to add software and how to add projects.
To get an overview of the software and projects you have added, click on the avatar icon at the top right:
Clicking on "My software", "My projects" or "My organizations" will take you to a profile page showing an overview of all pages you maintain. Once you have finished adding content, "Logout" can be used to sign out.
If you would like to get access on the production version of the RSD, you can find more information on our How to get access and Register your organization pages.
RSD DocumentationIf you wish to officially add your organization to the RSD, or claim an organization which is already listed but not an official member yet, please contact the RSD administrators and clearly provide the following information:
We will then contact you to arrange access for your organization. Once your organization is registered, this will indicated by a verification checkmark on the card of your organization:
In the RSD, we interpret the term "organization" very broadly. Any organization involved in the development of research software should be able to join the RSD. Examples of organizations include (but are not limited to):
RSD DocumentationTo make a new release we use github action release_manual.yml to manually release all modules at once.
Follow these steps to call release action.
create release draft (manual) actionIf you need to remove draft release you can do that via github interface
If you need to remove tag from the repository use following commands.
# delete locally
+git tag -d {tag}
+# remove from origin
+git push origin --delete {tag}
+# or more specifically
+git push origin :refs/tags/{tag}
+Documentation in progress.
RSD DocumentationBefore you can add content to the RSD, you need to be able to sign in using one of the supported identity providers:
More information on how to get access via these identify providers can be found in How to get an account.
To sign in to the RSD, go to the "Sign in" button at the top right corner of the page and select the identity provider you wish to use:
If you sign in to the RSD for the first time, the identify provider may ask you permission to share information with the RSD.
SurfConext is an identity provider for Dutch research and education institutions. It can be used by employees of these organizations to sign in to the RSD using their institute credentials. Before they can do so, however, an organization must enable the RSD service in their SURFconext dashboard.
TIP
You can check here if your organization has enabled the RSD service in SURFConext.
To sign in using SURFConext, go to the "sign in" button at the top right corner of the page and select the SURFConext identity provider. Next, select the appropriate organization and then enter your credentials in the organization specific sign in page that follows.
ORCID is the Open Research and Contributor ID. It provides a unique, persistent identifier for researchers and is widely used to identify their contributions to research outputs. You can also use ORCID as an identity provider to sign in to the RSD. Currently, ORCID sign in is enabled on an individual basis by the RSD administrators.
TIP
Please contact us if you wish to use your ORCID to sign in to the RSD.
To sign in using ORCID, go to the "sign in" button at the top right corner of the page and select the ORCID identity provider. Next, enter your credentials on the ORCID sign in page that follows.
To sign out, you can use the profile button the top right corner of the page and select "Logout".
RSD DocumentationDocumentation in progress.