Giter VIP home page Giter VIP logo

scientific-python.org's People

Contributors

alphapapa avatar astrojuanlu avatar brianhawthorne avatar bsipocz avatar carreau avatar dependabot[bot] avatar dschult avatar eriknw avatar hameerabbasi avatar inessapawson avatar jarrodmillman avatar jjerphan avatar juanis2112 avatar kne42 avatar melissawm avatar mriduls avatar mukulikaa avatar nabobalis avatar noatamir avatar patch4747 avatar perimosocordiae avatar pllim avatar pre-commit-ci[bot] avatar rlratzel avatar rossbar avatar stefanv avatar story645 avatar tacaswell avatar tomnicholas avatar tupui avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

scientific-python.org's Issues

DEV: Problem building site locally due to missing partial

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.

Use site-wide settings for custom.css

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;
}

CI Improvement: Prevent lighthouse failure from blocking the deploy preview

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.

Cleanup

We need to cleanup a few things leftover from #58 and scientific-python/specs#55.

  • Project Gallery. I copied and minimally changed people gallery. This needs to be cleaned up. For example, maybe we should have a logo instead of an avatar. Do we still want to have core projects register (w/ file in core-projects)? If so, should we autocreate the gallery (maybe just listing the project order?)? Basically, how should we avoid having to update two things to add / remove core projects? Maybe we only need project name, logo, and github page for project registration....
  • People Gallery. Maybe we should register SSC members in a directory. And autocreate SSC gallery in MetaSPEC1. This might be useful if we want to have the SSC listed elsewhere (e.g., on the main site about page under people?).
  • General Gallery. Currently you need to manually layout the grid. Maybe we could have something that intelligently decides the grid layout. Should we link to github and homepage? I like this contributor gallery: https://nteract.io/about They have logo/avatar, name, github, and homepage (optional). This makes sense for projects and people galleries. If we have separate icon for github and homepage for projects, we could have the logo/name link to the core-projects page w/ endorsed_specs listed.
  • Metaspec header. Remove discussion field.
  • If we have logos for projects, maybe we should use them instead of the names for endorsed_by displays with hoover that reveals names. Clicking on the logo should probably still link to core-projects page w/ endorsed_specs listed.

New Landing Site for Scientific Python

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.

Scientific Python ecosystem website

  • Getting Started

    • Short overviews of where you can go for questions like:
      • 2D, 3D plotting
      • doing "machine learning"
      • training a neural network
  • Ecosystem

    • Sub-pages for various categories of potential interest (this is not necessarily comprehensive; should likely be fairly broad -- not single "discipline")
      • Viz
      • statistics / data science / ML
      • life sciences
      • build / test / package tools
      • IDEs & notebooks
      • interoperability
  • Community

    • Awards
    • Diversity
    • Communication / Mailing list
    • Teaching / Educators
  • Success Stories

    • Use cases from industry, academia (similar to python.org style "success stories" -- also useful for reporting / paper / grant purposes)
  • Sponsors

    • How do I sponsor packages in the scientific Python ecosystem?
  • 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.

News

  • add announcement for planning next decade grant
  • finish SPEC announcement news (add video to youtube channel)
  • add announcement for inclusive community grant
  • add announcement for new theme / website

Calendar

  • grant (due dates)
  • conference (submissions, dates)
  • community calls / developer meetings
  • summits / meetings

color scheme

Update color scheme (and maybe fonts). This may involve refactoring the theme.

Social media icons fall off the side of the screen

Please describe the bug or issue including how to reproduce it.

The social media icons on scientific-python.org spill off the side of the screen:

image

Add any other context about the problem here, screenshots, etc.

Here are some minimal CSS rules that fixed this for me:

.social-media-icons {
    display: flex;
    flex-wrap: wrap;
    gap: 0.2em;
}

image

Idea for the "Get Started" page: add installation info

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:

  • Add a tabbed-view shortcode to the scientific-python-hugo-theme
  • Add a section on installation prior to the "Hello Scipy" section on the learning page
  • Use the tabbed view to describe how to install packages using either Python builtins (pip+venv) or conda

AB project pages

As an example, I added specs/meta-spec-0002/networkx.md using specs/meta-spec-0002/register.py.

  • In build artifact spec page,
    screenshot
    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
    screenshot
    But, the gray box should include the project header fields instead of the spec header fields.

  • In specs/meta-spec-0002.html,
    screenshot
    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.

Submitting one-off events to the calendar

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?

Meeting times are off due to daylight savings

Please describe the bug or issue including how to reproduce it.

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.

Add any other context about the problem here, screenshots, etc.

No response

ecosystem/install

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"

  • https://www.youtube.com/watch?v=Ul79ihg41Rs

  • Remove info on non-recommended installation methods

    • Remove info on installing w/ system package managers (see #112)
    • Remove info on binaries (see #112)
    • Reword section on installing from source to link to the "developer installation" info. (see #112)
  • 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

community/why-contribute

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:

  • work with some of the best programmers in the world
  • learn how to be a much better developer through peer review
  • advance science by building better tools for more accurate, transparent results and improved reproducibility
  • do impactful work, available to everyone and used by thousands if not millions of people
  • discover the agency you have in shaping the tools you need, use, and own

More informative title for calendars

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.

Feature/Easter egg: incorporate random.codes

@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!

Grants

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.

Fields

  • funder
  • dates (start, end)
  • link to proposal
  • link to progress reports
  • software (we expand what we did for core projects)
  • project leads (use gallery)
  • keywords (for searching)

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.

Keywords

  • Do we have the correct six "keywords"?
  • Is each keyword well expressed?
    • Is the title ok?
    • Is the text ok?
  • Are they in the correct order?

FAQ

Maybe we should add a FAQ.

Add FAQ (Frequenty Asked Questions) section

Common questions heard (add to this list as you hear them!):

  • What's the difference between Scientific Python and NumFOCUS
  • Same with PyData. Basically a state of the whole ecosystem.

Misc cleanups from theme transition

ENH: Add a site-wide glossary and index of acronyms

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.

Scientific Python BOF shirts!

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.

Scientific Python community meetings

Describe your issue.

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.

Get Help page doesn't exist

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.

Community Page

This page is focused on new contributors. It assumes they have been through the ecosystem page.

ecosystem/next-steps

https://github.com/scientific-python/scientific-python.org/blob/main/content/en/ecosystem/next-steps.md

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.

  • Consider moving the Hello Scipy section to the installation page.
  • ...
  • Record video

Write up how to choose an editor

I find the current posts out there a bit lacking in context, so perhaps we should add this material to our website.

  • Explain the purpose of an editor
  • Explain the difference between an editor and an IDE
  • Give an opinionated sample of good editors and IDEs
  • Demonstrate how to use an editor to create and modify files

Shorter name for branding

Please describe the new feature.

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.

Add any other context about the new feature here, screenshots, etc.

It is unfortunate that "scipy" is already taken. 😉

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.