ERDDAP: Improve experience using protected datasets

[ChrisJohnNOAA]

There is a lot of interest in this project. If you're interested in ERDDAP, but not just this project it could be worth looking at the other project listed: https://github.com/ioos/gsoc/issues/45 or thinking about other projects within ERDDAP. There are a lot of potential projects in ERDDAP, so letting me know your skills and particular interests could let me suggest a different project in ERDDAP.

Project Description

Define a way for protected datasets to be used from code. Most likely this would be an API that would enable users to authenticate directly from code (like R, Matlab, and Python scripts). Currently the primary authentication method is OAuth2, and there are a couple paths forward. 1) Provide client side libraries for major languages (like R, Matlab, and Python) to allow authentication. 2) Provide an alternative authentication mechanism (temporary access tokens). This would resolves issues like: https://github.com/ERDDAP/erddap/issues/92 and make ERDDAP a much more useful service for groups that want to have protected datasets.

Expected Outcomes

The ability for users to easily interact with protected ERDDAP datasets from code.

Skills required

Java, API design, optionally OAuth, Matlab, Python, R

Mentor(s)

Chris John (@ChrisJohnNOAA)

Expected Project Size

175

What is the difficulty of the project?

Intermediate

[smitsekhadiaa]

Hello @ChrisJohnNOAA I hope this messgae finds you well. I am Smit Sekhadia and am new to ERDDAP! I am a Final year Undergraduate Student pursuing Information Technology at VJTI, Mumbai.

I have been an active Open Source contributor, am looking forward to contribute to ERDDAP for GSoC 2024 as well! I have professional experience in Java, Spring and API development previously

I went through the idea list of this years project topics for ERDDAP and found this project very interesting and relishing.

I am looking forward to contribute to ERDDAP and have setup the repo on my local.

Regards, Smit Sekhadia

[ChrisJohnNOAA]

Hello Smit.

Thanks for getting in touch.

There's a lot going on with ERDDAP right now and we recently moved our documentation so I wanted to make sure you saw the most recent at https://erddap.github.io/

With project setup instructions at https://erddap.github.io/setup.html

If you're eager to contribute to the project, we have some issues labelled with "good first issue" that you're welcome to take a look at,

It's great to meet you!

Chris

[NEGRAH-S]

Hello @ChrisJohnNOAA , i am interested to contribute to above issue, is there any communication for same.

[ChrisJohnNOAA]

Hello @ChrisJohnNOAA , i am interested to contribute to above issue, is there any communication for same.

Hello @NEGRAH-S , thanks for expressing your interest. There has been other interest in this project. Are you interested in ERDDAP in general or specifically the protected dataset project?

My above comment would be good for you to read about the ERDDAP documentation. If you are interested in doing a project with ERDDAP it would be good to get your environment setup (https://erddap.github.io/setup.html) and check out the ERDDAP issues for first projects.

[ChrisJohnNOAA]

Hello Smit.

Thanks for getting in touch.

There's a lot going on with ERDDAP right now and we recently moved our documentation so I wanted to make sure you saw the most recent at https://erddap.github.io/

With project setup instructions at https://erddap.github.io/setup.html

If you're eager to contribute to the project, we have some issues labelled with "good first issue" that you're welcome to take a look at,

It's great to meet you!

Chris

@smitsekhadiaa , sorry should have made sure you were mentioned in the first message.

I also wanted to add a link the the ERDDAP good first issues: https://github.com/ERDDAP/erddap/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22

[swift-001]

Hello @ChrisJohnNOAA I am Soumya gupta, a second year undergrad from IIT Kanpur.

While going through the project ideas list of your organization for gsoc24 I came across this project idea and found it very interesting.I believe I have the skills required for successful completion of the project.

I have proficient knowledge and experience in JAVA and Python.Also i have done one course on matlab in my first year and am currently doing two courses with MATLAB simulation sessions.

I am looking forward to contributing to ERDDAP this summer. could you please guide me on how to get started?

[ChrisJohnNOAA]

Hello @ChrisJohnNOAA I am Soumya gupta, a second year undergrad from IIT Kanpur.

While going through the project ideas list of your organization for gsoc24 I came across this project idea and found it very interesting.I believe I have the skills required for successful completion of the project.

I have proficient knowledge and experience in JAVA and Python.Also i have done one course on matlab in my first year and am currently doing two courses with MATLAB simulation sessions.

I am looking forward to contributing to ERDDAP this summer. could you please guide me on how to get started?

Hello @soumyagupta5643 ,

The best way to get started would be to set up your dev environment. There are directions in the documentation on this page: https://erddap.github.io/setup.html

After that looking at the issues, in particular those labelled good first issue could allow you to make a smaller change to familiarize yourself with ERDDAP: https://github.com/ERDDAP/erddap/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22

Lastly, this goes for everyone in this thread. There is a lot of interest in this project. If you're interested in ERDDAP, but not just this project it could be worth looking at the other project listed: https://github.com/ioos/gsoc/issues/45 or thinking about other projects within ERDDAP. There are a lot of potential projects in ERDDAP, so letting me know your skills and particular interests could let me suggest a different project in ERDDAP.

[AntimaDwivedi]

Hi @ChrisJohnNOAA , This is Antima, a newbie in open-source but I have a good understanding of JAVA, Spring BOOT, and Python. I am looking forward to contributing to this project for GSOC 2024. I am adaptive to learning new technologies as per the requirements of this project.

I have covered all the discussions mentioned above between you and fellow contributors and I am in the middle of setting up the dev environment by following the link https://erddap.github.io/setup.html

Steps covered till now

1. Installed Adoptium's OpenJDK (Temurin) 17 (LTS)

2. Installed Tomcat and verified.

I am facing difficulties when I am setting up the tomcat/content/erddap configuration files.

When I was changing the setup.xml file, I faced difficulties with the below confusion.

1. can I use my Gmail account for the attribute or do I need any mail account associated with any organization?

2. Similarly, what should I put on the below attributes if I have only a Gmail account?

<adminInstitution>Your Institution</adminInstitution>
<adminInstitutionUrl>Your Institution's or Group's Url</adminInstitutionUrl>
<adminIndividualName>Your Name</adminIndividualName>
<adminPosition>ERDDAP administrator</adminPosition>
<adminPhone>+1 999-999-9999</adminPhone>
<adminAddress>123 Main St.</adminAddress>
<adminCity>Some Town</adminCity>
<adminStateOrProvince>CA</adminStateOrProvince>
<adminPostalCode>99999</adminPostalCode>
<adminCountry>USA</adminCountry>
<adminEmail>your.email@yourCompany.com</adminEmail>

I am setting up the environment on my Windows machine.

I would highly appreciate it if you help me with the below doubts. Thank you in advance !!

[ChrisJohnNOAA]

Hi @ChrisJohnNOAA , This is Antima, a newbie in open-source but I have a good understanding of JAVA, Spring BOOT, and Python. I am looking forward to contributing to this project for GSOC 2024. I am adaptive to learning new technologies as per the requirements of this project.

I have covered all the discussions mentioned above between you and fellow contributors and I am in the middle of setting up the dev environment by following the link https://erddap.github.io/setup.html

Steps covered till now

1. Installed Adoptium's OpenJDK (Temurin) 17 (LTS)
2. Installed Tomcat and verified.

I am facing difficulties when I am setting up the tomcat/content/erddap configuration files.

When I was changing the setup.xml file, I faced difficulties with the below confusion.

1. can I use my Gmail account for the attribute or do I need any mail account associated with any organization?
2. Similarly, what should I put on the below attributes if I have only a Gmail account?

<adminInstitution>Your Institution</adminInstitution>
<adminInstitutionUrl>Your Institution's or Group's Url</adminInstitutionUrl>
<adminIndividualName>Your Name</adminIndividualName>
<adminPosition>ERDDAP administrator</adminPosition>
<adminPhone>+1 999-999-9999</adminPhone>
<adminAddress>123 Main St.</adminAddress>
<adminCity>Some Town</adminCity>
<adminStateOrProvince>CA</adminStateOrProvince>
<adminPostalCode>99999</adminPostalCode>
<adminCountry>USA</adminCountry>
<adminEmail>your.email@yourCompany.com</adminEmail>

I am setting up the environment on my Windows machine.

I would highly appreciate it if you help me with the below doubts. Thank you in advance !!

Hi @AntimaDwivedi, you can use your Gmail account. You'll need to put something in those fields (several of them are validated to not be the placeholder), but for local development it's fine to use your school or home address.

[AntimaDwivedi]

Hi @ChrisJohnNOAA Thank you for your help!! Finally, I have set it up locally on my machine.

[ChrisJohnNOAA]

Hi @ChrisJohnNOAA Thank you for your help!! Finally, I have set it up locally on my machine.

Is there anything in the good first issue list you're interested in as a way to get to know ERDDAP a little better? https://github.com/ERDDAP/erddap/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22

[AntimaDwivedi]

yes @ChrisJohnNOAA, I am going through documents about datasets for my better understanding. Soon I will start looking into the good first issues.

[AntimaDwivedi]

Hi @ChrisJohnNOAA, can I start looking into this https://github.com/ERDDAP/erddap/issues/38. I think this will be a good start to understand the ERDDAP. I would appreciate it if you give any suggestions and tips.

[AntimaDwivedi]

@ChrisJohnNOAA, I am also open and welcome it if you suggest and assign any issue that you think might be a good start.

[ChrisJohnNOAA]

@AntimaDwivedi I added a comment to erddap#38 that might be helpful. For other (particularly) good first issues, there is Data citation and Inaccurate logs

[AntimaDwivedi]

Hey @ChrisJohnNOAA

Just wanted to inform you about my current situation

I am currently working as a software engineer for an organization, but never worked on open-source projects, which is why landed at GSOC. Before exploring the organization, I read all the eligibility criteria applied for me and I was sure I was eligible and chose a medium-length project of IOOS to contribute. But I was just revisiting the FAQs and got this https://developers.google.com/open-source/gsoc/faq#i_am_a_professional_software_engineer_but_i_have_not_participated_in_open_source_communities_before_am_i_eligible

I have mailed to GSOC admin to confirm my eligibility for GSOC. Once I get a response, I will confirm with you too about my participation in GSOC and resume my work if I get a positive response.

[ChrisJohnNOAA]

Hey @AntimaDwivedi

Thanks for letting me know. If you want experience contributing to open source projects, even if you aren't eligible, I'm always open to more contributors for ERDDAP. Though I do understand if that's not feasible for you without the GSOC support.

Let me know what they say.

[AntimaDwivedi]

Hi @ChrisJohnNOAA , Thank you for encouraging me to contribute to ERDDAP and explore open-source development through ERDDAP regardless of GSOC. Fortunately, the GSOC admin's reply is also in my favor.

The FAQ you linked shows multiple options of how you can a person would still be considered a beginner. You need to decide if those situations fit you.

If you are contributing to an open source project for the first time and you started contributing recently (in the last couple of months) then you would be a beginner still.

GSoC Admins

I have resumed my work and started looking into the issue.