Skip to content

Commit e800059

Browse files
committed
updates with more details
1 parent f61a26c commit e800059

File tree

1 file changed

+61
-8
lines changed

1 file changed

+61
-8
lines changed

finance/proposal-calls/cycle3/user-dev-support-rse.md

Lines changed: 61 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,79 @@ Research Software Engineer: User and Developer Support
44

55
### Project Team
66

7-
TBD
7+
- Adrian Price-Whelan
8+
- TBD (please add your name if you would be interested in helping manage or coordinate
9+
this role!)
810

911
### Project Description
1012

11-
A research software engineer (RSE) position with an equivalent ~50% FTE appointment to tackle both user-facing and developer-facing support issues.
13+
A research software engineer (RSE) position with an equivalent ~50% FTE appointment to
14+
tackle both user-facing and developer-facing support issues, as identified and
15+
prioritized by the Astropy community and infrastructure teams. The RSE would have a
16+
"manager" who is an existing Astropy contributor with existing knowledge of the Astropy
17+
core package, ecosystem, infrastructure packages, and community. The RSE is expected to
18+
eventually work independently, but with feedback from the Manager and Astropy community.
1219

1320
### Project / Work
1421

22+
The broad scope of work for the RSE includes any efforts to support both Astropy users
23+
and contributors, including, for a few general examples, update the Astropy core
24+
documentation theme, automate release procedures for infrastructure packages, or
25+
implement more specific projects related to Astropy core subpackages (some examples
26+
given below).
27+
28+
The RSE position is distinct from the Software Operational Support Specialist (SOSS)
29+
position in that the RSE is expected to take on and complete discrete *projects*, rather
30+
than provide continuous support (e.g., monitoring issues, helping new contributors,
31+
etc., as was included in the SOSS scope of work).
32+
33+
The exact projects that the RSE tackles and detailed implementation plans should be
34+
discussed, prioritized, and fleshed out by the Astropy community and RSE together if
35+
this funding request is accepted. A few possible projects are included below as
36+
examples, some drawn from the [Astropy
37+
Roadmap](https://github.com/astropy/astropy-project/blob/main/roadmap/roadmap.md), but
38+
these should not be considered as the exact plan of work for the RSE — the RSE will work
39+
independently, so some aspects of project priority will stem from their expertise and
40+
interest.
41+
1542
Example projects:
16-
* Overhaul the Astropy developer documentation to include entry points for contributors with different skill levels.
17-
* Review the full Astropy documentation; research best practices in software documentation and implement changes to the structure of the docs, or propose a path toward overhauling the docs layout and structure to match best practices.
18-
* Support maintenance of Astropy coordinated (and other affiliated) packages and project infrastructure.
19-
* TBD
43+
* *Restructure the Astropy developer documentation*: The current developer documentation
44+
pages have a wealth of content aimed at both new contributors and expert technical
45+
engineers, but it is mixed and hard for contributors with different skill levels to
46+
easily find the content most appropriate for them. The goal of this project is to
47+
restructure the documentation pages to provide easier pathways for potential or
48+
existing contributors with different skill levels to find relevant developer
49+
documentation they need to make a contribution. Relevant issues:
50+
[#11620](https://github.com/astropy/astropy/issues/11620),
51+
[#11621](https://github.com/astropy/astropy/issues/11621)
52+
* *Explore switching the Astropy documentation theme to the Pydata theme*: Many other
53+
software packages that work with NumFOCUS have switched to using the [Pydata sphinx
54+
theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/). This project would pick
55+
up where Madison Bray left off in exploring whether it makes sense to switch the
56+
Astropy documentation to this theme as well, as a way of reducing custom
57+
infrastructure and sharing infrastructure with other projects. Relevant issues:
58+
[#11520](https://github.com/astropy/astropy/issues/11520)
59+
* *Implement robust benchmark reporting for pull requests*: This project would enable a
60+
way of evaluating the performance impact of pull requests by tracking and benchmarking
61+
existing performance of common tasks (see, for example, the old
62+
[astropy-benchmarks](https://github.com/astropy/astropy-benchmarks)).
63+
* *Implement integration testing for core, coordinated, and infrastructure packages*:
64+
Ensure that coordinated and infrastructure packages have integration tests that check
65+
the joint usage of Astropy and these other packages together, rather than individually
66+
(as is often the case now).
67+
2068

2169
### Approximate Budget
2270
Currency: US $84,000
2371

24-
salary (50% appointment) + $8000 travel allotment
72+
**Position**: Research Software Engineer
2573

74+
Budget breakdown:
2675
- Travel: $8000
2776
- Conference Registrations: $1000
28-
- Salary / contractor fees etc.: $75000
77+
- Salary / contractor fees etc.: $75000
2978
- TOTAL = $84000
79+
80+
**Position**: Manager of Research Software Engineer
81+
82+
Unfunded, but could be a funded position.

0 commit comments

Comments
 (0)