scientific-python / scientific-python.org Goto Github PK
View Code? Open in Web Editor NEWSource for the Scientific Python Project homepage.
Home Page: https://scientific-python.org
License: BSD 3-Clause "New" or "Revised" License
Source for the Scientific Python Project homepage.
Home Page: https://scientific-python.org
License: BSD 3-Clause "New" or "Revised" License
Just figured I'd raise a new issue in case this was unexpected and/or has a simple fix:
When building locally via make serve-dev
, I get the following build errors:
Start building sites …
hugo v0.88.1+extended linux/amd64 BuildDate=unknown
ERROR 2021/10/20 22:04:54 render of "page" failed: "/home/ross/repos/scientific-python.org/themes/scientific-python-hugo-theme/layouts/_default/baseof.html:4:7": execute of template failed: template: _default/single.html:4:7: executing "_default/single.html" at <partial "meta.html" .>: error calling partial: partial "meta.html" not found
ERROR 2021/10/20 22:04:54 render of "page" failed: "/home/ross/repos/scientific-python.org/themes/scientific-python-hugo-theme/layouts/_default/baseof.html:4:7": execute of template failed: template: _default/single.html:4:7: executing "_default/single.html" at <partial "meta.html" .>: error calling partial: partial "meta.html" not found
ERROR 2021/10/20 22:04:54 render of "page" failed: "/home/ross/repos/scientific-python.org/themes/scientific-python-hugo-theme/layouts/_default/baseof.html:4:7": execute of template failed: template: _default/single.html:4:7: executing "_default/single.html" at <partial "meta.html" .>: error calling partial: partial "meta.html" not found
ERROR 2021/10/20 22:04:54 render of "page" failed: "/home/ross/repos/scientific-python.org/themes/scientific-python-hugo-theme/layouts/_default/baseof.html:4:7": execute of template failed: template: _default/single.html:4:7: executing "_default/single.html" at <partial "meta.html" .>: error calling partial: partial "meta.html" not found
Error: Error building site: failed to render pages: render of "page" failed: "/home/ross/repos/scientific-python.org/themes/scientific-python-hugo-theme/layouts/_default/baseof.html:4:7": execute of template failed: template: _default/single.html:4:7: executing "_default/single.html" at <partial "meta.html" .>: error calling partial: partial "meta.html" not found
Built in 37 ms
make: *** [Makefile:15: serve-dev] Error 255
I'm pretty sure all my submodules are up-to-date (ran git submodule update --init
to make sure I got the scientific-python-hugo-theme
and git pull upstream main --recurse-submodules
), but maybe I'm missing something here. FWIW I'm on f7d7cd4 of scientific-python-hugo-theme
.
We override the default highlight color in config.toml
:
[Params.style.vars]
highlightColor = "#57ad68" # Override highlight color
It would be nice if we could just change the color here, but we currently also need to manually change it in static/css/custom.css
here
.spec-meta .field-value a {
color: #57ad68;
font-weight: bold;
}
and here
.adopted-specs-list a {
color: #57ad68;
font-weight: bold;
}
We should list Community Managers
etc. under People
in the shortcuts:
https://scientific-python.org/about/
I recently ran into an issue where I was getting intermittent/arbitrary failures in the "performance" metric from lighthouse. The problem with this is that lighthouse failures cause the entire netlify CI run to fail, which prevents the preview from deploying (AFAICT). I think it'd be an improvement if lighthouse failures could be treated as non-blocking; i.e. have the site preview still deploy when the build is successful, even if lighthouse fails.
We want to add the Monthly Pandas Dev Meeting to the calendars page but they already have a calendar link. See here:
https://pandas.pydata.org/docs/dev/development/meeting.html
Is it possible to add a link to their .ics file instead of generating a calendar?
That way we won't need to maintain another calendar and make sure they remain coordinated 😉
At least in #202 it is.
It'd be nice if this were set back to the basic deploy preview - the lighthouse report is great and should be made accessible in the CI links, but being able to see the site preview is also important.
When clicking the "copy" button on the calendars page, the URL is missing a slash:
https:/scientific-python.org/calendars/numpy.ics
Thanks @sayantikabanik for noticing!
We need to cleanup a few things leftover from #58 and scientific-python/specs#55.
endorsed_by
displays with hoover that reveals names. Clicking on the logo should probably still link to core-projects page w/ endorsed_specs listed.A few members of the Scientific Python Community (@stefanv, @NelleV, @slumnitz, @rgommers) met at UC BIDS to discuss the confusion / issues with having scipy.org as the main landing page for the entire scientific Python ecosystem (i.e., SciPy the community vs. SciPy the library vs. SciPy the conference & who updates this page & so on).
One proposal is to "rebrand" with a new scientific-python
landing page that is disambiguated from the conference SciPy and the SciPy library proper.
We're interested in getting community input about issues like governance (having representation from the different scientific "domains" / communities/ groups) so please let us know what you think about this idea.
The initial thought is that changes would be made to the site in a completely open and transparent & inclusive (!) manner via pull requests.
Getting Started
Ecosystem
Community
Success Stories
Sponsors
Events
Should also have explicit information on how this page works, how content gets decided, on how to suggest modifications.
Example: python.org
EDIT: consensus after a set of discussions seemed to be to use pydata.org for this "portal site" rather than creating a new one.
Update color scheme (and maybe fonts). This may involve refactoring the theme.
The current command line guide linked to is reasonable, but everything is folded up in boxes making it hard to read. The video at the top is quite fun, but we may want to link to that directly and then also to a slightly more in-depth guide, such as https://ubuntu.com/tutorials/command-line-for-beginners#1-overview or https://launchschool.com/books/command_line/read/command_line_interface#whatisaninterface
The social media icons on scientific-python.org spill off the side of the screen:
Here are some minimal CSS rules that fixed this for me:
.social-media-icons {
display: flex;
flex-wrap: wrap;
gap: 0.2em;
}
On the main page, there is a "Get Started" button that takes the user to this Getting Started page which has some info on how to use various interactive tools like notebooks or IPython, a "Hello world" example, etc.
One thing that IMO would improve the page is an explanation of how to install the packages of the ecosystem. I think this is a "missing link" for the material that's already on the page, since absolute new-comers would likely struggle with the "hello scipy" example if they don't have the necessary packages installed!
The trick of course is that there are many possible workflows. I'd advocate to focus on those that use virtual environments, since this is a best-practice for scientific Python users (as opposed to using system Python + system package managers, for example). There's still the problem of which workflow specifically to highlight. Here I would advocate for two specifically: one based on Python built-ins (i.e. pip
and venv
) and one based on conda
.
One nice way to highlight multiple ways of doing things is to use tabbed views in the webpage. I know some Hugo themes support this - I've used this feature in the past for similar purposes. For example, see this site, specifically "Step 1a" and onwards, where I detailed how to set up a development environment using either conda
or pip+venv
. (Note that the development environment is more involved than just installing packages as a user, so that site has much more detail than we'd need for the Get Started page here!)
I'm not sure whether the theme currently supports tabbed views, but it would be a nice feature to add for use-cases like this. The example above uses the hugo learn theme and the tabbed views are very easy to use.
Here's a quick summary of my thoughts/suggestions:
pip
+venv
) or conda
As an example, I added specs/meta-spec-0002/networkx.md using specs/meta-spec-0002/register.py.
In build artifact spec page,
NetworkX shouldn't be in the list. That table should only list specs/*.md
files, but shouldn't include markdown files in subdirectories.
The AB project pages need specialized processing and they have different headers. For example, specs/meta-spec-0002/networkx.html currently looks like
But, the gray box should include the project header fields instead of the spec header fields.
In specs/meta-spec-0002.html,
The gray box should have a field projects with NetworkX
listed as a link to specs/meta-spec-0002/networkx.html. In general, it should include a comma separated list of project names that link to specs/meta-spec-0002/<project>.html
.
Some of the NumPy Newcomers’ Hours have no agenda, and to some of them, we invite guest speakers. In such cases, we have a custom/modified entry in our Google calendar. What would be the best way to submit this info to the new .ics calendar?
I'm not sure exactly which meetings are affected, but at least the NumPy community + triage meetings and the NetworkX community meeting are now 1 hr off after the time change. This is likely due to the fact that the meetings times are specified in UTC (+00:00 offset). I'm not sure what the appropriate syntax is for properly handling timezones.
No response
It would be great to have the Discord invite on the website!
https://github.com/scientific-python/scientific-python.org/blob/main/content/en/ecosystem/install.md
Focus on virtual environments, since this is a best-practice for scientific Python users (as opposed to using system Python + system package managers, for example). There's still the problem of which workflow specifically to highlight. Here I would advocate for two specifically: one based on Python built-ins (i.e. pip and venv) and one based on conda. It may also make sense to incorporate Juanita's "Spyder says: Don't mix pip and conda"
Remove info on non-recommended installation methods
Maybe grab Hello scipy from next steps.
Add section about using virtual environments?
Add section about building from source that links to the developer videos.
...
Record video
I think it would be good to also outline the benefits of contributing to open source software. Possible points to highlight, at least from the coding perspective:
When I follow the subscription instructions for google calendar w/ a URL link, the calendar gets added fine, but the full URL is used by the calendar name as default. For example, adding the scipy calendar I get: https://scientific-python.org/calendars/scipy.ics
as the calendar name in my gcal sidebar. I then have to go into the calendar settings and rename it manually to something more sensible (e.g. SciPy community calendar).
It'd be nice if there were a way to pick up this name automatically - of course, this may be a limitation of google calendar so maybe there's nothing to be done here, but I figured I'd raise it on the off chance that there is some field/property in yaml2ics
that could be set to make this naming work automatically.
@MridulS has made a really fun feature at randomsource.codes that drops you into a web editor in a random source file from one of the core scientific Python ecosystem projects. It's sort of like a "review a random file" feature akin to Wikipedia's "random article" button.
This might be a fun feature to add to the site somewhere!
We should have a grants page.
This is from our grant proposal outcomes table:
Community receives more funding to more individuals
(a) Grant proposals from multiple PIs
(b) Community list of grant opportunities
(c) Record of submitted proposals & archive of funded proposals
We have @melissawm (PR #78) and our (I need to move the content from the frontpage) grants already. It probably makes sense to organize that somewhat like we organize the SPECs. Maybe a separate repo so that folks don't have to touch everything. We will need some custom fields so that there are consistent headers. It would also be good if we could autogenerate a list of funded and unfunded grants like we do for the SPECs. Ideally folks would be able to search and sort these lists according to various properties. While we ramp things up, we should focus on just the a few grants. But eventually it would be useful to be more welcoming of grants.
If we start with just the two grants, we can do this iteratively and just implement things as we need. I can keep both grants manually updated as we change things.
It would be nice to have a glossary page with definitions for common terms/phrases and a listing of acronyms. Potential entries might include:
Originally mentioned in scientific-python/specs#50 but raising here for visibility.
I'm the coordinator of the PyAOS (Python for Atmosphere and Ocean Science; https://pyaos.github.io/) community and for some time now we've been looking for a replacement for our current mailing list. A discourse category is exactly what we're looking for and would love to host it at https://discuss.scientific-python.org if possible?
Here's the source repository (with license): https://github.com/PyAOS/pyaos.github.io
There is something wrong with how the meta stuff works for spec-0000/index.md
.
https://preview.scientific-python.org/specs/spec-0000/
Here is what it should look like:
https://preview.scientific-python.org/specs/spec-0001/
Specifically, when spec-0000/index.md
is rendered, it is missing the Discussion
, Endorsed by
, and WARNING
sections.
We are planning to have all the SPECs live in directories (i.e., spec-0000/index.md
, spec-0001/index.md
, etc.).
Maybe we should add a FAQ.
Common questions heard (add to this list as you hear them!):
I'm thinking something along the lines of what sphinx has with the :term:
and :abbr:
roles, where the former links the term to a glossary entry, and the latter adds a pop-up box that shows the full name associated with an acronym when a user hovers over the link with their cursor.
I haven't looked closely, so it's possible the mainroad
theme already supports some or all of this. If not, maybe this functionality could be added via shortcodes.
Not a critical feature by any means, I just thought it'd be a nice improvement given the number of new terms and acronyms that are on the site.
Leave a comment on this issue if you'd like to be part of the shirt raffle at SciPy 2022. Please specify your shirt size and if you prefer FEMALE (V-neck), or MALE (crew-neck) shirt.
I think we should have Scientific Python community meetings same as all the projects have their own meetings, except that in these we can gather members from different projects and start to open conversations about things that are relevant to all of them (like specs). I think having regular meetings might help to keep things going. Also it could help to update people in the community about what we have been up to. Maybe 1 every 2 weeks makes sense at the beginning.
Let me know what you think @stefanv, @jarrodmillman, @tupui. I'm happy to create a 'whenisgood' survey and share it on our discord server in order to find a schedule that fits best for people interested. Then we can add it to our calendar. Also I can be in charge of hosting the meetings, I don't mean to load any of you with more work.
On every page other than the landing page, there is a left sidebar that has two elements: a non-clickable Shortcuts sidebar entry, and a Get Help
link. If a user clicks on the Get Help
link, they are taken to a page that doesn't seem to exist (or at least is not properly set up yet.
The header spacing on, e.g., https://scientific-python.org/code_of_conduct/ is inconsistent.
No response
This page is focused on new contributors. It assumes they have been through the ecosystem page.
Added in #12 to get the website preview working in CI. Not sure what the impact is on the deployed website, so revisit this if there are deployment issues.
This should provide pointers to the next steps a new user should take after installing. It should mainly point to a few good resources and point out a few tools people will need to get started. This text is from the old scipy.org site and should be rewritten. It may be reasonable to discard all the existing text and reorganize things.
Hello Scipy
section to the installation page.I find the current posts out there a bit lacking in context, so perhaps we should add this material to our website.
Local problem that I should probably fix, but it may affect more future viewers of the page:
The draft document emoji doesn't render for me either on the desktop or on the phone, consider using a more basic one.
E.g. here: https://draft.scientific-python.org/specs/spec-0000/
At NumFOCUS Summit 2022, someone commented that "Scientific Python" is a mouthful and would be nice to have a shorter brand name people can use verbally. Someone (sorry, I forgot who) suggested "SPP" (I also forgot what the second P stands for, sorry).
However, SPP has a bitter taste for some astronomers because it is a language used in the now-almost-defunct IRAF. It was not the most fun language you had to program in (though you will never forget it once you do).
This issue is hopefully for people to brainstorm for more ideas.
It is unfortunate that "scipy" is already taken. 😉
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.